Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Support channels

Retrieve support channel

Retrieves the details of an existing support channel.

Required permissions:

  • support_chat:read
get/support_channels/{id}

Path parameters

idstring required

The unique identifier of the support channel to retrieve.

Response

A successful response

company_idstring nullable required

The unique identifier of the company associated with this channel. Null if this is not a support or company-scoped conversation.

custom_namestring nullable required

A custom display name assigned to this channel by the user. Null if no custom name has been set.

idstring required

The unique identifier for the entity

last_message_atstring date-time nullable required

The timestamp when the most recent message was sent in this channel. Null if no messages have been sent.

resolved_atstring date-time nullable required

The timestamp when the linked support ticket was marked as resolved. Null if unresolved or not a support chat.

Example response

{
  "custom_name": "Project Alpha Team",
  "customer_user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "last_message_at": "2023-12-01T05:00:00.401Z",
  "resolved_at": "2023-12-01T05:00:00.401Z"
}