Contacts

A contact represent a single individual, typically human.

View contacts

Fetch a list of contacts

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

Returns a paginated list of an organization's contacts.

Query Parameters

Name	Type	Description
include[]	String	If set to deleted all active and deleted records will be returned in the response.
page	Integer	For more info, see the pagination section in the Getting started guide.
limit	Integer	For more info, see the pagination section in the Getting started guide.
search	String	Optional: can be used to search for contact details. (Don't forget to URL encode query parameters)

Example request

curl

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

View a contact

Fetch a single contact

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

Returns a single contact. If you need to gather user metadata as well you may reduce the number of requests by using the ?include[] parameter.

Path Parameters

Name	Type	Description
:contact_id*	String

Query Parameters

Name	Type	Description
include[]	String	You can include tags, pets, phone_numbers, email_addresses, locations, and/or expertise_tags metadata.

Example request

curl

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

Create a contact

You may have duplicate contacts within a platform or across various platforms like LinkedIn or Facebook. If you have a connection with an individual on one of these platforms it's recommended you create that user via a import or through one of the integrations. These workflows will allow you to stage new users, we attempt to find duplicate contacts and allow you to resolve duplicate warnings before importing contacts.

Create a contact

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

Request Body

Name	Type	Description
contact[first_name]*	String
contact[middle_name]	String
contact[last_name]	String
contact[relationship_type]*	Integer	Required: 0 - 5 Learn more about relationship types.
contact[nickname]	String
contact[employer]	String
contact[job_title]	String
contact[linkedin_url]	String
contact[how_you_met]	String
contact[birthday]	String	ISO8601 format, learn more.
contact[gender]	String	Options: male, female, transgender, non-binary, other

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'contact[relationship_type]=1' \
    -d 'contact[first_name]=Bart'

Update a contact

Update a contact

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

Request Body

Name	Type	Description
contact[first_name]	String
contact[middle_name]	String
contact[last_name]	String
contact[relationship_type]	Integer	Required: 0 - 5 Learn more about relationship types.
contact[nickname]	String
contact[employer]	String
contact[job_title]	String
contact[linkedin_url]	String
contact[how_you_met]	String
contact[birthday]	String	ISO8601 format, learn more.
contact[gender]	String	Options: male, female, transgender, non-binary, other

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/contacts/:contact_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'contact[nickname]=Bartman'

Delete a contact

Delete a contact

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

Path Parameters

Name	Type	Description
:contact_id*	String

Request Body

Name	Type	Description
soft_delete	String	Learn more about deleting records.

Example request

curl

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