Contact metadata

Table of contents

Locations

Phone numbers

Email addresses

Relationships

Tags

Expertise tags

Pets

Gifts

Notes

Locations / addresses

View a contact's locations

Fetch a list of contact's addresses

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses

Returns a list of an contact's locations/addresses.

Query Parameters

Name
Type
Description

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses \
    -X GET \
    -H 'Authorization: Bearer <token>'

Create a location for a contact

Create a contact's address

POST https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses

Request Body

Name
Type
Description

address[address_line_1]*

String

address[address_line_2]

String

address[address_line_3]

String

address[locality]*

String

address[region]*

String

address[postcode]*

String

address[country]*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'address[address_line_1]=742 Evergreen Terrace' \
    -d 'address[locality]=Springfield' \
    -d 'address[region]=Illinois' \
    -d 'address[postcode]=54321' \
    -d 'address[country]=United States of America'

Update a contact's location

Update an address

PATCH https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses/:address_id

Request Body

Name
Type
Description

address[address_line_1]

String

address[address_line_2]

String

address[address_line_3]

String

address[locality]*

String

address[region]*

String

address[postcode]*

String

address[country]*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses/:address_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'address[address_line_2]=Attn: Bart'

Delete a location/address

Delete an address

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses/:address_id

Path Parameters

Name
Type
Description

:contact_id*

String

Request Body

Name
Type
Description

soft_delete

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/addresses/:address_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Phone numbers

View a contact's phone numbers

Fetch a list of a contact's phone numbers

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers

Returns a paginated list of a contact's phone numbers.

Query Parameters

Name
Type
Description

page

Integer

limit

Integer

include[]

Boolean

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers \
    -X GET \
    -H 'Authorization: Bearer <token>'

View a phone number

Fetch a single phone number

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers/:phone_id

Path Parameters

Name
Type
Description

:phone_id*

UUID

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers/:phone_id \
    -X GET \
    -H 'Authorization: Bearer <token>'

Add a phone number to a contact record

Create a phone number

POST https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers/:phone_id

Request Body

Name
Type
Description

phone_number[phone_number]*

UUID

Accepts a phone string with an extension. See example below.

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'phone_number[phone_number]=800-555-5555 ext. 123'

Update a phone number

Update a phone number

PATCH https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers/:phone_id

Path Parameters

Name
Type
Description

:phone_id*

UUID

Request Body

Name
Type
Description

phone_number[phone_number]

String

phone_number[deleted]

Boolean

If set to false this will 'undelete' a previously deleted record.

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers/:phone_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'phone_number[phone_number]=8004445555'

Delete a phone number

Delete a phone number

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers/:phone_id

Path Parameters

Name
Type
Description

:phone_id*

UUID

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/phone-numbers/:phone_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Email addresses

View a contact's email addresses

Fetch a list of a contact's email addresses

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/email-addresses

Returns a paginated list of a contact's email addresses.

Query Parameters

Name
Type
Description

page

Integer

limit

Integer

include[]

Boolean

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails \
    -X GET \
    -H 'Authorization: Bearer <token>'

View a email address

Fetch a single email address

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails/:email_id

Path Parameters

Name
Type
Description

:email_id*

UUID

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails/:email_id \
    -X GET \
    -H 'Authorization: Bearer <token>'

Add a contact's email address

Create an email address

POST https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails

Request Body

Name
Type
Description

email[email_address]*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'email[email_address]=marge@springfieldcity.gov'

Update an email address

Update an email address

PATCH https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails/:email_id

Request Body

Name
Type
Description

email[email_address]*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails/:email_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'email[email_address]=marge@example.com'

Delete an email address

Delete an email address

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails/:email_id

Path Parameters

Name
Type
Description

:email_id*

UUID

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/emails/:email_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Contact relationships

View contact relationships

Please note this endpoint returns a list of relationships you create with your contact(s). This does not return your entire contact list. If you'd like to retrieve all your contacts visit this page.

Fetch a list of a contact's relationships

GET https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships

Returns a list of relationships created for a given contact.

Query Parameters

Name
Type
Description

include[]

String

page

Integer

limit

Integer

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships \
    -X GET \
    -H 'Authorization: Bearer <token>'

View an individual relationship

Fetch an individual contact relationship record

GET https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships/:contact_relationship_id

Path Parameters

Name
Type
Description

:contact_relationship_id*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships/:contact_relationship_id \
    -X GET \
    -H 'Authorization: Bearer <token>'

Create a relationship

Create a contact relationship record

POST https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships

Creates a relationship record between two contacts. The relationship is assumed from the position of the contact included in the path.

Request Body

Name
Type
Description

contact_relationship[second_contact_id]*

String

contact_relationship[anniversary_date]

contact_relationship[relationship_id]*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'contact_relationship[second_contact_id]=17659d00-8866-44b7-bde3-ec9816652da9' \
    -d 'contact_relationship[anniversary_date]=2020-07-22' \
    -d 'contact_relationship[relationship_id]=85fb935d-1601-4695-9e88-3e63ff019f68'

Update a relationship

Update a relationship record

PATCH https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships/:contact_relationship_id

Path Parameters

Name
Type
Description

:contact_relationship_id*

String

When editing the UUID should be included as a path parameter

Request Body

Name
Type
Description

user_relationship[anniversary_date]*

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships/:contact_relationship_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'contact_relationship[anniversary_date]=2019-07-22' \

Delete a relationship connection

Delete a relationship record

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships/:contact_relationship_id

Path Parameters

Name
Type
Description

:contact_relationship_id*

String

UUID of the relationship to be deleted.

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contact_relationships/:contact_relationship_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Tags

View a contact's tags

Fetch a list of a contact's tags

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/tags

Returns a paginated list of an contact's tags.

Query Parameters

Name
Type
Description

include[]

String

page

Integer

limit

Integer

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/tags \
    -X GET \
    -H 'Authorization: Bearer <token>'

Attach a tag to a contact

Create a contact tag link

PUT https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/tags/:tag_id

Path Parameters

Name
Type
Description

:contact_id*

String

:tag_id*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/tags/:tag_id \
    -X PUT \
    -H 'Authorization: Bearer <token>'

Delete an contact tag connection

Delete the link between a contact and a tag

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/tags/:tag_id

Path Parameters

Name
Type
Description

:contact_id*

String

:tag_id*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/tags/:tag_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Expertise tags

View a contact's expertise tags

Fetch a list of a contact's expertise tags

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/expertises

Returns a paginated list of an contact's expertise tags.

Query Parameters

Name
Type
Description

include[]

String

page

Integer

limit

Integer

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/expertises \
    -X GET \
    -H 'Authorization: Bearer <token>'

Attach an expertise tag to a contact

Create a contact expertise tag link

PUT https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/expertises/:expertise_id

Path Parameters

Name
Type
Description

:contact_id*

String

:expertise_id*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/expertises/:expertise_id \
    -X PUT \
    -H 'Authorization: Bearer <token>'

Delete an contact expertise tag connection

Delete the link between a contact and an expertise tag

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/expertises/:expertise_id

Path Parameters

Name
Type
Description

:contact_id*

String

:expertise_id*

String

Request Body

Name
Type
Description

soft_delete

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/expertises/:expertise_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Pets

View a contact's pets

Fetch a list of contact's pets

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets

Returns a paginated list of a user's pets.

Query Parameters

Name
Type
Description

page

Integer

limit

Integer

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets \
    -X GET \
    -H 'Authorization: Bearer <token>'

View a pet

Fetch a single pet

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets

Path Parameters

Name
Type
Description

:pet_id*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets \
    -X GET \
    -H 'Authorization: Bearer <token>'

Create a pet related to a contact

Create a contact's pet

POST https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets

Request Body

Name
Type
Description

pet[type]

String

Dog, cat, etc...

pet[name]*

String

pet[date_of_birth]

String

pet[secondary_contact_id]

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'pet[name]=Snowball II'

Update a pet

Update a pet

PATCH https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets/:pet_id

Path Parameters

Name
Type
Description

:pet_id*

String

Request Body

Name
Type
Description

pet[name]

String

pet[type]

String

pet[date_of_birth]

String

pet[secondary_contact_id]

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets/:pet_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'pet[type]=Cat'

Delete a pet

Delete a pet

DELETE https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets/:pet_id

Path Parameters

Name
Type
Description

:pet_id*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/pets/:pet_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Gifts

View gifts associated with a contact

Fetch a list of contact's gifts

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts

Returns a paginated list of a user's gifts.

Query Parameters

Name
Type
Description

page

Integer

include[]

String

limit

Integer

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts \
    -X GET \
    -H 'Authorization: Bearer <token>'

View a gift

Fetch a single gift

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gift/:gift_id

Path Parameters

Name
Type
Description

:gift_id*

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts \
    -X GET \
    -H 'Authorization: Bearer <token>'

Create a gift related to a contact

Create a contact gift

POST https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts

Request Body

Name
Type
Description

gift[name]*

String

gift[link]

String

gift[status]*

String

Options: potential, given, received

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'gift[name]=Vacuum' \
    -d 'gift[status]=potential'

Update a gift

Update a gift

PATCH https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts/:gift_id

Request Body

Name
Type
Description

gift[name]

String

gift[link]

String

gift[status]

String

Options: potential, given, received

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts/:gift_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'gift[status]=given'

Delete a gift

Delete a gift

DELETE https://web.r0app.com/api/v1/orgs/:org_id

Path Parameters

Name
Type
Description

:gift_id*

String

Request Body

Name
Type
Description

soft_delete

String

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/gifts/:gift_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'

Notes

View a contact's notes

Fetch a contact's notes

GET https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/notes

Returns a paginated list of notes in your account.

Query Parameters

Name
Type
Description

page

Integer

limit

Integer

include[]

String

include[]

String

If set to tags the first few tags associated with a note will be included in the response.

Example request

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id/notes \
    -X GET \
    -H 'Authorization: Bearer <token>'
PreviousContactsNextNotes

Last updated