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

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

​
Path Parameters

ParameterTypeRequiredDescription
tagIdstringYesThe unique slug identifier of the tag whose values are to be fetched. Obtain this from the Tag List API.

​
Query Parameters

ParameterTypeRequiredDescription
valuestringNoFilter tag values by value text (partial match). Min 1, Max 200 characters.
limitintegerNoNumber of records to return. Min 1, Max 100.
cursorstringNoCursor for pagination. Default 0.

​
Code Examples

curl -X GET "https://api.pazy.io/v1.0/tags/cost-center/values?limit=30" \
  -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 values response data
data.tagsarrayList of values configured for the tag
data.tags[].idnumberUnique identifier for the tag value (use this as tagId in the Invoice List API to filter invoices by this value)
data.tags[].valuestringThe tag value text
data.tags[].dateCreatedstringDate when the tag value was created (ISO 8601 format)
data.tags[].isActivebooleanIndicates whether the tag value is currently active
data.contextobjectPagination metadata
data.context.hasMorebooleanIndicates whether there are more tag values to fetch
data.context.nextCursornumberCursor to fetch the next page

​
Response Example

{
  "ok": true,
  "data": {
    "tags": [
      {
        "id": 1024,
        "value": "Engineering",
        "dateCreated": "2026-01-10T08:15:30Z",
        "isActive": true
      },
      {
        "id": 1025,
        "value": "Marketing",
        "dateCreated": "2026-01-12T09:00:00Z",
        "isActive": true
      },
      {
        "id": 1026,
        "value": "Legacy Ops",
        "dateCreated": "2025-09-05T11:42:00Z",
        "isActive": false
      }
    ],
    "context": {
      "hasMore": false,
      "nextCursor": 30
    }
  }
}

​
Error Responses

​
Tag Not Found

HTTP Status: 404 Not Found 
{
  "ok": false,
  "error": {
    "code": "TAG_NOT_FOUND",
    "message": "Tag not found"
  }
}

​
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 from a tag value as the tagId parameter in the Invoice List API to filter invoices that carry this tag value
  • The isActive field indicates whether the value is still in use — inactive values are returned for historical reference but should not be used on new transactions
  • Use value to narrow down results — partial matching is supported (e.g., Eng matches Engineering)
  • Use cursor and limit together to paginate; nextCursor from the response can be used as the cursor value for the next call