Skip to content

List tags

Endpoint

GET /organizations/{org_id}/tags

Retrieves all tags in the specified organization.

Request

Replace {org_id} with your Organization ID.

Headers

  • Authorization: Bearer {your_access_token}
  • Accept: application/json
  • X-Tallyfy-Client: APIClient

Query parameters (optional)

  • q (string) - Search by tag name.
  • with (string) - Include related data. Supported value: statistics.
  • all (string) - Set to true to include auto-generated process tags, which aren’t returned by default.
  • per_page (integer) - Tags per page. Defaults to 10.
  • page (integer) - Page number for pagination.
  • sort (string) - Sort by a property. Prefix with - for descending order.

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';
const queryParams = '?with=statistics&page=1&per_page=10';
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/tags${queryParams}`;
const headers = {
'Authorization': `Bearer ${accessToken}`,
'Accept': 'application/json',
'X-Tallyfy-Client': 'APIClient'
};
fetch(apiUrl, { method: 'GET', headers })
.then(response => {
return response.json().then(data => {
if (!response.ok) throw new Error(`Error ${response.status}: ${JSON.stringify(data)}`);
return data;
});
})
.then(data => {
console.log('Tags:', JSON.stringify(data, null, 2));
// Pagination info at data.meta.pagination
})
.catch(error => console.error('Failed to list tags:', error.message));

Response

You’ll get a 200 OK response with a JSON object containing a data array of tags and meta pagination info.

Each tag object contains these fields from the TagTransformer: id, title (max 30 chars), color, auto_generated, created_at, and deleted_at.

If you’ve requested with=statistics, each tag also includes a nested statistics object with: active_template, archived_template, active_process, and archived_process counts.

{
"data": [
{
"id": "tag_id_abc",
"title": "Urgent",
"color": "#e74c3c",
"auto_generated": false,
"created_at": "2025-01-15T10:00:00Z",
"deleted_at": null,
"statistics": {
"data": {
"active_template": 5,
"archived_template": 2,
"active_process": 12,
"archived_process": 3
}
}
}
],
"meta": {
"pagination": {
"total": 25,
"count": 10,
"per_page": 10,
"current_page": 1,
"total_pages": 3
}
}
}

Tags > Get tag

Retrieve a specific tag by its ID using a GET request to…

Groups > List groups

Retrieve a paginated list of all groups in your Tallyfy organization. Filter by name, sort…