curl -X GET "https://api.contactship.ai/v1/tags" \
-H "x-api-key: your-api-key"
const response = await fetch('https://api.contactship.ai/v1/tags', {
headers: { 'x-api-key': 'your-api-key' },
});
const { data, pagination } = await response.json();
console.log(`${pagination.total_rows} tags found`);
import requests
response = requests.get(
'https://api.contactship.ai/v1/tags',
headers={'x-api-key': 'your-api-key'},
)
result = response.json()
for tag in result['data']:
print(f"{tag['name']} ({tag['color']}) — id: {tag['id']}")
{
"statusCode": 200,
"data": [
{
"id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-04-05T12:00:00Z"
},
{
"id": "tag-b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "customer",
"color": "#33FF57",
"label": "Customer",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-03-10T09:00:00Z"
}
],
"pagination": {
"page": 1,
"total_rows": 2,
"total_pages": 1
}
}
Etiquetas
List Tags
Retrieve all tags for your organization
GET
/
v1
/
tags
curl -X GET "https://api.contactship.ai/v1/tags" \
-H "x-api-key: your-api-key"
const response = await fetch('https://api.contactship.ai/v1/tags', {
headers: { 'x-api-key': 'your-api-key' },
});
const { data, pagination } = await response.json();
console.log(`${pagination.total_rows} tags found`);
import requests
response = requests.get(
'https://api.contactship.ai/v1/tags',
headers={'x-api-key': 'your-api-key'},
)
result = response.json()
for tag in result['data']:
print(f"{tag['name']} ({tag['color']}) — id: {tag['id']}")
{
"statusCode": 200,
"data": [
{
"id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-04-05T12:00:00Z"
},
{
"id": "tag-b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "customer",
"color": "#33FF57",
"label": "Customer",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-03-10T09:00:00Z"
}
],
"pagination": {
"page": 1,
"total_rows": 2,
"total_pages": 1
}
}
Returns a paginated list of tags belonging to your organization. Use the tag IDs to assign or remove tags from contacts.
Headers
string
requerido
Your API key for authentication. Found in your dashboard under API settings.
Query Parameters
number
predeterminado:"5"
Maximum number of tags to return. Must be ≥ 0.
number
predeterminado:"0"
Number of records to skip for pagination.
string
predeterminado:"desc"
Sort direction by creation date. Possible values:
asc, desc.string
Filter tags by name (partial match).
string
Filter tags by label (partial match).
Response
The response containsstatusCode, a data array, and pagination with page, total_rows, and total_pages.
array
object
Pagination metadata:
page, total_rows, and total_pages.Error Codes
401 Unauthorized— Invalid or missing API key500 Internal Server Error— Server-side error
Code Examples
curl -X GET "https://api.contactship.ai/v1/tags" \
-H "x-api-key: your-api-key"
const response = await fetch('https://api.contactship.ai/v1/tags', {
headers: { 'x-api-key': 'your-api-key' },
});
const { data, pagination } = await response.json();
console.log(`${pagination.total_rows} tags found`);
import requests
response = requests.get(
'https://api.contactship.ai/v1/tags',
headers={'x-api-key': 'your-api-key'},
)
result = response.json()
for tag in result['data']:
print(f"{tag['name']} ({tag['color']}) — id: {tag['id']}")
{
"statusCode": 200,
"data": [
{
"id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-04-05T12:00:00Z"
},
{
"id": "tag-b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "customer",
"color": "#33FF57",
"label": "Customer",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-03-10T09:00:00Z"
}
],
"pagination": {
"page": 1,
"total_rows": 2,
"total_pages": 1
}
}