Saltar al contenido principal
GET
/
v1
/
tags
curl -X GET "https://api.contactship.ai/v1/tags" \
  -H "x-api-key: your-api-key"
{
  "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"
    }
  ],
  "count": 2
}
Returns a paginated list of tags belonging to your organization. Use the tag IDs to assign or remove tags from contacts.

Headers

x-api-key
string
requerido
Your API key for authentication. Found in your dashboard under API settings.

Query Parameters

limit
number
predeterminado:"5"
Maximum number of tags to return. Must be ≥ 0.
offset
number
predeterminado:"0"
Number of records to skip for pagination.
order
string
predeterminado:"desc"
Sort direction by creation date. Possible values: asc, desc.
name
string
Filter tags by name (partial match).
label
string
Filter tags by label (partial match).

Response

data
array
Array of tag objects.
count
number
Total number of tags in your organization.

Error Codes

  • 401 Unauthorized — Invalid or missing API key
  • 500 Internal Server Error — Server-side error

Code Examples

curl -X GET "https://api.contactship.ai/v1/tags" \
  -H "x-api-key: your-api-key"
{
  "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"
    }
  ],
  "count": 2
}