Skip to main content
Channels

Get a channel pairing

Retrieve a pending or bound Channel pairing record.

Channel pairing is currently in Beta. API definitions, response structures, and behavior may change. Check the documentation for updates.
GET /api/v1/forward/channel_pairings/{pairing_id} Retrieve a pending or bound pairing record.

Request parameters

Use Authorization: Bearer <PAT or SAT>. The path parameter pairing_id is the id returned by List channel pairings.

Example request

curl -s 'https://api.qoder.com/api/v1/forward/channel_pairings/pair_019eabc123' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK 
{
  "id": "pair_019eabc123",
  "type": "channel_pairing",
  "channel_id": "channel_019eabc123",
  "scope_type": "direct",
  "scope_external_id": "external_user_id",
  "scope_display_name": "Test user",
  "status": "active",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_workspace_dev",
  "paired_at": "2026-09-09T08:00:00Z",
  "created_at": "2026-09-09T07:50:00Z",
  "updated_at": "2026-09-09T08:00:00Z"
}
scope_type is direct (private chat) or room (group chat). scope_external_id is the corresponding external user or group ID. For a pending record, status=pairing, and identity_id, template_id, and paired_at are empty strings. Pairing code expiration does not change this status. The API does not return the pairing code. Returns 404 if the record does not exist, has been unpaired, or is inaccessible to the caller; returns 401 for invalid credentials. scope_display_name is the user's nickname or group name, or an empty string if unavailable. It is updated by subsequent messages and is for display only. Use the external ID for authorization.

List channel pairings

Pair a channel

Update a channel pairing

First steps
Define your agent
Configure agent environment
Delegate work to your agent
Agent integrations
Manage agent context
Account
Best Practices
Announcements
API reference