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
include[]
String
page
Integer
limit
Integer
search
String
Optional: can be used to search for tags. (Don't forget to URL encode query parameters)
Example request
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
:tag_id*
String
Query Parameters
include[]
String
page
Integer
limit
Integer
Example request
Create a tag
Create a tag
POST https://web.r0app.com/api/v1/orgs/:org_id/tags
Request Body
tag[name]*
String
Example request
Update a tag
Update a tag
PATCH https://web.r0app.com/api/v1/orgs/:org_id/tags/:tag_id
Path Parameters
:tag_id*
String
Request Body
tag[name]*
String
Example request
Delete a tag
Delete a tag
DELETE https://web.r0app.com/api/v1/orgs/:org_id/tags/:tag_id
Path Parameters
:tag_id*
String
Request Body
soft_delete
String
Example request
Last updated