Skip to content
Tallyfy

List tags

Endpoint

GET /organizations/{org_id}/tags

This endpoint retrieves a list of tags available within 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)

Refer to Swagger for filtering options, which might include:

  • q (string): Search by tag title.
  • with (string): Include related data (e.g., statistics).
  • Pagination parameters (page, per_page).
  • Sorting parameters (sort).

Code samples

const accessToken = 'YOUR_PERSONAL_ACCESS_TOKEN';
const orgId = 'YOUR_ORGANIZATION_ID';


const queryParams = '?with=statistics&page=1'; // Example: Include stats, get first page
const apiUrl = `https://go.tallyfy.com/api/organizations/${orgId}/tags${queryParams}`;


const headers = new Headers();
headers.append('Authorization', `Bearer ${accessToken}`);
headers.append('Accept', 'application/json');
headers.append('X-Tallyfy-Client', 'APIClient');


fetch(apiUrl, {
    method: 'GET',
    headers: headers
})
.then(response => {
    return response.json().then(data => { // Attempt to parse JSON regardless of status
        if (!response.ok) {
            console.error("Failed to list tags:", data);
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return data; // Pass successful data along
    });
})
.then(data => {
    console.log('Successfully listed tags:');
    console.log(JSON.stringify(data, null, 2));
    // Access pagination: data.meta.pagination
})
.catch(error => {
    console.error('Error listing tags:', error.message);
});

Response

A successful request returns a 200 OK status code and a JSON object containing a data array. Each element represents a tag.

{
  "data": [
    {
      "id": "tag_id_abc", // Unique tag ID
      "title": "Urgent",
      "color": "#e74c3c", // Hex color code
      "template": 5, // Count of templates using this tag
      "active_process": 12, // Count of active processes using this tag
      "auto_generated": false,
      "created_at": "2025-01-15T10:00:00Z",
      "deleted_at": null,
      // Included if requested with 'with=statistics'
      "statistics": {
          // ... detailed usage counts ...
      }
    },
    {
       "id": "tag_id_def",
       "title": "Finance",
       "color": "#2ecc71",
       // ... other tag details ...
    }
  ],
  "meta": {
      // Pagination details if applicable
  }
}

Tags > Get tag

This API endpoint retrieves detailed information about a specific tag in an organization by its unique ID and supports optional parameters to include additional data like usage statistics.

Members > List members

This endpoint enables retrieval of all registered members within a Tallyfy organization by making a GET request with optional query parameters for including related group data and pagination controls.

Groups > List groups

This documentation explains how to retrieve a list of groups within a Tallyfy organization using a GET API endpoint with code examples provided in JavaScript Python Java Go C++ and C# that demonstrate the request structure including required authorization headers and optional query parameters for including additional data like group logos.

Tasks > List organization tasks

The GET endpoint retrieves all tasks across an organization’s processes and one-off tasks with extensive filtering options including status assignees deadlines tags folders and pagination while supporting multiple programming languages through code samples that demonstrate query parameter construction and response handling.
Get in touch
About Tallyfy