Sign in
latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Tags

Get Tags

Get a list of tags scoped by query parameters.

get/tags

Query parameters

idstring

Tag ID

Tag ID

namestring

Tag name. This is not a partial or fuzzy match but looks for an exact match of the tag name.

Tag name. This is not a partial or fuzzy match but looks for an exact match of the tag name.

organizationIdstring

Organization ID

Organization ID

agentVisibility'LEAD_PROFILES' | 'OPT_OUT' | 'NEVER'

The context in which an agent can see and collect tags. LEAD_PROFILES: Agents will be able to see these while sending messages and use them to collect info about contacts. OPT_OUT: Specifically for opt-out reasons. Will only be displayed when agents opt out a contact. NEVER: Only for admins. Agents will never see this tag.

The context in which an agent can see and collect tags. LEAD_PROFILES: Agents will be able to see these while sending messages and use them to collect info about contacts. OPT_OUT: Specifically for opt-out reasons. Will only be displayed when agents opt out a contact. NEVER: Only for admins. Agents will never see this tag.

cursorstring

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

limitnumber

Limit of items per page.

Limit of items per page.

Response

Returns a list of tags.

cursorstring nullable required

Cursor for start of next set of items. If there were no items to return with the last cursor you passed, this will return null.

hasMoreboolean required

Whether there are more items to load past this cursor.