Deployments.ai Docs
Runtime

List channel bindings

GET /v1/channel-bindings · SDK listChannelBindings · CLI deployments channel-binding list

GET
/v1/channel-bindings

Requires channels:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListChannelBindingsResponse

application/json
  1. response
channelBindings*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/channel-bindings"
{  "channelBindings": [    {      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "workspaceId": "string",      "agentDefinitionId": "string",      "agentDeploymentId": "string",      "channel": "imessage",      "connectionId": "string",      "credentialAttached": true,      "externalAccountId": "string",      "externalChannelId": "string",      "externalThreadKey": "string",      "externalWorkspaceId": "string",      "id": "string",      "lastVerifiedAt": "2019-08-24T14:15:22Z",      "metadata": {},      "object": "channel-binding",      "provider": "aws_end_user_messaging_rcs",      "status": "active"    }  ],  "nextCursor": "string"}