Config items

Overview

Config items are the individual Zendesk objects (triggers, macros, views, ticket fields, and so on) that Configly syncs from your connected instance. Each item is stored as a point-in-time snapshot of the raw Zendesk object, so the data you receive matches what the Zendesk API returns natively.

Two endpoints let you retrieve config items: one for paginated lists filtered by type, and one for fetching a single item by its Zendesk-native identifier.

List config items

GET /v1/connections/:connectionId/configs/:configType

Returns a paginated list of config items for the specified type from the most recent snapshot.

Query parameters

Example request

curl https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/configs/triggers?page=1&limit=10&sort=id&order=asc \
  -H "Authorization: Bearer cly_your_key"

Example response

{
  "data": [
    {
      "id": 12345,
      "title": "Auto-close solved tickets",
      "active": true,
      "conditions": { "...": "..." },
      "actions": [ "..." ]
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 47,
    "totalPages": 5
  }
}

Get a single config item

GET /v1/connections/:connectionId/configs/:configType/:itemId

Returns a single config item by its Zendesk-native identifier. The :itemId parameter accepts numeric IDs (used by most types) or string keys (used by custom objects and some field types).

Example request

curl https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/configs/triggers/12345 \
  -H "Authorization: Bearer cly_your_key"

Example response

{
  "data": {
    "id": 12345,
    "title": "Auto-close solved tickets",
    "active": true,
    "conditions": { "...": "..." },
    "actions": [ "..." ]
  }
}

Valid config types

The :configType path parameter must be a recognised type (for example, triggers, macros, views, ticket_fields). If you supply an unknown type, the API returns a 400 VALIDATION_ERROR whose body includes a validTypes array listing every accepted value:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Unknown config type: 'foobar'",
    "status": 400,
    "validTypes": ["groups", "schedules", "ticket_fields", "..."]
  }
}

Error codes