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 required path parameter pairing_id is the id returned by List channel pairings.
Example request
Example response
HTTP 200 OK
scope_type is direct (private chat) or room (group chat), and 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 pairing codes.
scope_display_name is the user's nickname or group name. It may be empty and is for display only.
HTTP error codes
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | pairing_id is blank or contains control characters, or the Channel is not in pairing mode. |
| 401 | authentication_error | PAT or SAT is invalid or expired. |
| 403 | permission_error | The caller does not have permission to invoke the API. |
| 404 | not_found_error | The pairing does not exist or has been unpaired, or its Channel does not exist, is archived, or is inaccessible. |