Connections – Configly Help Centre

Overview

Every API key is scoped to a single Zendesk connection. These endpoints return metadata about the connection your key has access to, including sync status and per-type config counts.

List connections

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

Returns an array containing the single connection your API key is scoped to. The response is wrapped in an array for forward compatibility.

Get connection summary

curl -H "Authorization: Bearer cly_your_key" \
  https://api.configly.app/v1/connections/{connectionId}/summary

Returns the same shape as the list endpoint, but for a specific connection ID. The connectionId must match the one your API key is scoped to; a mismatch returns 403.

Response shape

{
  "data": [
    {
      "id": "clx1abc...",
      "subdomain": "yourcompany",
      "authMethod": "oauth",
      "status": "active",
      "lastTestedAt": "2026-04-15T10:00:00.000Z",
      "lastTestStatus": "ok",
      "lastSyncAt": "2026-04-15T09:30:00.000Z",
      "configCounts": {
        "triggers": 47,
        "automations": 12,
        "macros": 89,
        "views": 34
      },
      "createdAt": "2026-01-10T14:00:00.000Z",
      "updatedAt": "2026-04-15T10:00:00.000Z"
    }
  ]
}

Field	Type	Description
`id`	string	Connection identifier. Use this as `connectionId` in all other endpoints.
`subdomain`	string	Zendesk subdomain (e.g. `yourcompany`).
`authMethod`	string	How the connection authenticates with Zendesk (`oauth`).
`status`	string	`active` or `inactive`.
`lastTestedAt`	string or null	ISO 8601 timestamp of the last connection test.
`lastTestStatus`	string or null	Result of the last connection test.
`lastSyncAt`	string or null	ISO 8601 timestamp of the most recent sync.
`configCounts`	object	Keys are config type names, values are the number of items of that type.
`createdAt`	string	ISO 8601 timestamp.
`updatedAt`	string	ISO 8601 timestamp.

Error codes

Code	Status	Cause
`INVALID_API_KEY`	401	Missing or invalid API key.
`FORBIDDEN`	403	The API key does not have access to the requested connection.

Note

Both endpoints require a read-only API key at minimum. For fetching the config items within a connection, see Config items.

Related to