Skip to main content
Tag List API
curl --request GET \
  --url https://api.pazy.io/v1.0/tags

Documentation Index

Fetch the complete documentation index at: https://docs.pazy.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

All requests require an API key in the request headers. Headers: 
Authorization: Api-Key YOUR_API_KEY

​
Request

Content-Type: application/json

​
Query Parameters

ParameterTypeRequiredDescription
limitintegerNoNumber of records to return. Min 1, Max 100.
cursorstringNoCursor for pagination.

​
Code Examples

curl -X GET https://api.pazy.io/v1.0/tags \
  -H "Authorization: Api-Key YOUR_API_KEY"

​
Success Response

HTTP Status: 200 OK Response Fields:
FieldTypeDescription
okbooleanIndicates whether the request was successful
dataobjectContains the tag list response data
data.tagsarrayList of tags configured for the organization
data.tags[].idstringUnique slug identifier for the tag (use this as tagSlug in the Tag Detail API)
data.tags[].namestringDisplay name of the tag
data.contextobjectPagination metadata
data.context.hasMorebooleanIndicates whether there are more tags to fetch
data.context.nextCursorstringCursor to fetch the next page

​
Response Example

{
  "ok": true,
  "data": {
    "tags": [
      {
        "id": "cost-center",
        "name": "Cost Center"
      },
      {
        "id": "project",
        "name": "Project"
      },
      {
        "id": "department",
        "name": "Department"
      }
    ],
    "context": {
      "hasMore": false,
      "nextCursor": null
    }
  }
}

​
Error Responses

​
Authentication Errors

HTTP Status: 401 Unauthorized 
{
  "ok": false,
  "error": {
    "code": "MISSING_CREDENTIALS",
    "message": "Missing Credentials"
  }
}

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API Key"
  }
}

​
Permission Errors

HTTP Status: 403 Forbidden 
{
  "ok": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Permission check failed - PERMISSION_CHECK_FAILED"
  }
}

​
Internal Error

HTTP Status: 500 Internal Server Error 
{
  "ok": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}

​
Best Practices

  • Use the id (slug) returned for a tag as the tagSlug path parameter in the Tag Detail API to retrieve the available values for a tag
  • Tags are organization-scoped — only tags configured under your organization are returned