GET /user-api/v1/tags
Query Parameters
Set a limit to the number of records to return (Default:25)
Number of records to skip.
Sort order: created_at:asc, created_at:desc, name:asc, name:desc
Related data to include: contacts, companies, tasks
| Header | Value |
|---|
x-rolodex-api-key | f1e2d3c4b5a697... |
Response
{
"pagination": {
"limit": 25,
"offset": 0,
"total": 150
},
"data": [
{
"id": "tag_12345",
"name": "Lead",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
},
{
"id": "tag_67890",
"name": "Hot Prospect",
"created_at": "2025-01-14T09:15:00Z",
"updated_at": "2025-01-14T09:15:00Z"
}
]
}
With Include Parameters
GET /user-api/v1/tags?include=contacts,companies,tasks
Response with all includes
{
"pagination": {
"limit": 25,
"offset": 0,
"total": 150
},
"data": [
{
"id": "tag_12345",
"name": "Lead",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z",
"contacts": [
{
"id": "contact_123",
"full_name": "John Doe",
"image_url": "https://example.com/avatar.jpg"
}
],
"companies": [
{
"id": "company_456",
"name": "Acme Corp",
"logo_url": "https://example.com/logo.png"
}
],
"tasks": [
{
"id": "task_789",
"body": "Follow up with lead"
}
]
}
]
}
GETTag
GET /user-api/v1/tags/:id
Path Parameters
Query Parameters
Related data to include: contacts, companies, tasks
Endpoint Example
GET /user-api/v1/tags/tag_12345?include=contacts,companies
Response
{
"data": {
"id": "tag_12345",
"name": "Lead",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}
}
