ID resolver

Overview

The ID resolver turns Zendesk numeric IDs into human-readable display names. This is useful when working with dependency graph results or raw config data that contains numeric references to groups, brands, ticket fields, and other objects.

Two endpoints are available: a single-ID lookup via GET and a bulk lookup via POST (which handles up to 500 items per request).

Resolve a single ID

GET /v1/connections/:connectionId/resolve/:objectType/:zendeskId

The :objectType parameter must be one of the valid lookup types listed below (singular form). The :zendeskId is the numeric Zendesk identifier.

Example request

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

Example response

{
  "data": {
    "displayName": "Support",
    "zendeskId": "12345",
    "objectType": "group",
    "found": true,
    "metadata": null
  }
}

Resolve in bulk

POST /v1/connections/:connectionId/resolve

Resolves up to 500 IDs in a single request. The POST method is used to accommodate large payloads; this is still a read-only operation.

Request body

{
  "items": [
    { "objectType": "group", "zendeskId": "12345" },
    { "objectType": "ticket_field", "zendeskId": "67890" },
    { "objectType": "brand", "zendeskId": "99999" }
  ]
}

Example request

curl -X POST https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/resolve \
  -H "Authorization: Bearer cly_your_key" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"objectType":"group","zendeskId":"12345"},{"objectType":"brand","zendeskId":"99999"}]}'

Example response

{
  "data": {
    "resolved": [
      {
        "displayName": "Support",
        "zendeskId": "12345",
        "objectType": "group",
        "found": true,
        "metadata": null
      }
    ],
    "unresolved": [
      {
        "displayName": "Unknown",
        "zendeskId": "99999",
        "objectType": "brand",
        "found": false,
        "metadata": null
      }
    ]
  },
  "meta": {
    "total": 2,
    "resolvedCount": 1,
    "unresolvedCount": 1
  }
}

Valid lookup types

The resolver supports a subset of all config types. The following 16 types are accepted:

Supplying an unrecognised type returns a 400 VALIDATION_ERROR with a validTypes array in the error body.

Error codes