Tags

Summary

Tags are a form of metadata that can be associated with different objects, allowing for more efficient organization, searching, and categorization. Think of tags as labels that are attached to a particular object, much like attaching a sticky note to a document in a file cabinet. For example, you might have a 'Soccer' tag that you assign to everyone on your soccer team.

View tags

Fetch a list of tags

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

Returns a paginated list of an organization's tags.

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 tags. (Don't forget to URL encode query parameters)

Example request

curl

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

View contacts associated with a tag

Fetch a list of contacts with a given tag

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

Returns a paginated list of an contacts that have a given tag associated with them.

Path Parameters

Name	Type	Description
:tag_id*	String

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.

Example request

curl

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

Create a tag

Create a tag

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

Request Body

Name	Type	Description
tag[name]*	String

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/tags \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -d 'tag[name]=Soccer'

Update a tag

Update a tag

PATCH https://web.r0app.com/api/v1/orgs/:org_id/tags/:tag_id

Path Parameters

Name	Type	Description
:tag_id*	String

Request Body

Name	Type	Description
tag[name]*	String

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/tags/:tag_id \
    -X PATCH \
    -H 'Authorization: Bearer <token>' \
    -d 'tag[name]=Football'

Delete a tag

Delete a tag

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

Path Parameters

Name	Type	Description
:tag_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/tags/:tag_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'