Retrieve a list of tags (get)
The get
Ortto endpoint of the tags
entity is used to retrieve a list of the person or organization tags in Ortto’s customer data platform (CDP).
This page provides descriptions of this endpoint’s:
-
valid parameters, headers, and request body values, as well as
-
the response payload.
Headers
This endpoint requires a custom API key and content type (application/json
for the request body) in the header of the request:
-
X-Api-Key: CUSTOM-PRIVATE-API-KEY
-
Content-Type: application/json
Request body
The request body consists of a JSON object with an optional search term.
{
"q": "search-term"
}
Response payload
The response payload consists of a JSON object with the elements listed in the table below.
The following JSON object is an example of the tag data that Ortto retrieves from your Ortto account’s CDP after a request to this endpoint.
{
{
"id": 1,
"instance_id": "orttodocs",
"name": "VIP",
"source": "csv",
"created_by_id": "123456789012345678901234",
"created_by_name": "Team Ortto",
"created_by_email": "help@ortto.com",
"created_at": "2022-03-15T01:48:51.164Z",
"last_used": "2022-08-10T05:56:57.697Z",
"count": 43,
"sms_opted_in": 20,
"subscribers": 42,
"type": ""
}
}
Response payload elements
The following table lists all elements (arrays, objects, or fields) in the response from a request to this endpoint.
Element | Description |
---|---|
|
The ID of the tag, useful for applying as a filter when getting a group of contacts. |
|
The instance name of the account where this request is being made. |
|
The name of the tag. |
|
The name of the source where the tag was created, possible values include: csv, api, manual, zapier. |
|
If the tag was created by a user (e.g. csv or api source), returns the ID of that user. |
|
If the tag was created by a user (e.g. csv or api source), returns the name of that user. |
|
If the tag was created by a user (e.g. csv or api source), returns the email of that user. |
|
A timestamp of the date the tag was created. |
|
A timestamp of the last time this tag was used. |
|
The total contacts assigned this tag. |
|
The total contacts assigned this tag and with SMS permission set to true. |
|
The total contacts assigned this tag and with Email permission set to true. |
|
Specifies if this is a person tag, or an organization tag. An empty response signifies a 'person' tag, and "organization" signifies an `organization' tag. |