> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # List support channels > Returns a paginated list of support channels for a specific company, with optional filtering by resolution status and custom sorting. Required permissions: - `support_chat:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /support_channels openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /support_channels: get: tags: - Support channels summary: List support channels description: >- Returns a paginated list of support channels for a specific company, with optional filtering by resolution status and custom sorting. Required permissions: - `support_chat:read` operationId: listSupportChannel parameters: - explode: true in: query name: after required: false schema: description: >- Returns the elements in the list that come after the specified cursor. type: string style: form - explode: true in: query name: before required: false schema: description: >- Returns the elements in the list that come before the specified cursor. type: string style: form - explode: true in: query name: first required: false schema: description: Returns the first _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: last required: false schema: description: Returns the last _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: company_id required: false schema: description: >- The unique identifier of the company to list support channels for. Includes channels of child companies. When omitted, returns support channels across all companies the user has access to. example: biz_xxxxxxxxxxxxxx type: string style: form - explode: true in: query name: view required: false schema: $ref: '#/components/schemas/SupportChannelView' description: >- Filter support channels by the authenticated user's role. Defaults to admin. When the caller is a company API key (no user), only admin-visible channels are returned. style: form - explode: true in: query name: open required: false schema: description: >- Whether to filter by open or resolved support channels. Set to true to only return channels awaiting a response, or false for resolved channels. type: boolean style: form - explode: true in: query name: direction required: false schema: $ref: '#/components/schemas/Direction' description: >- The sort direction for the results. Use 'asc' for oldest first or 'desc' for newest first. style: form - explode: true in: query name: order required: false schema: $ref: '#/components/schemas/MessageChannelOrder' description: >- The field to sort the support channels by, such as creation date or last message time. style: form responses: '200': content: application/json: schema: description: The connection type for DmsFeed. properties: data: description: A list of nodes. items: $ref: '#/components/schemas/SupportChannelListItem' type: array page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. required: - data - page_info type: object description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - support_chat:read x-codeSamples: - lang: JavaScript source: >- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const supportChannelListResponse of client.supportChannels.list()) { console.log(supportChannelListResponse.id); } components: schemas: SupportChannelView: description: The perspective to filter support channels by. enum: - all - admin - customer type: string Direction: description: The direction of the sort. enum: - asc - desc type: string MessageChannelOrder: description: Sort options for message channels enum: - created_at - last_post_sent_at type: string SupportChannelListItem: description: >- A messaging channel that can be a one-on-one DM, group chat, company support conversation, or platform-level direct message. properties: company_id: description: >- The unique identifier of the company associated with this channel. Null if this is not a support or company-scoped conversation. type: - string - 'null' custom_name: description: >- A custom display name assigned to this channel by the user. Null if no custom name has been set. example: Project Alpha Team type: - string - 'null' customer_user: description: >- The customer who initiated this support conversation. Null if this is not a support chat. properties: id: description: The unique identifier for the user. example: user_xxxxxxxxxxxxx type: string name: description: The user's display name shown on their public profile. example: John Doe type: - string - 'null' username: description: The user's unique username shown on their public profile. example: johndoe42 type: string required: - id - name - username type: - object - 'null' id: description: The unique identifier for the entity type: string last_message_at: description: >- The timestamp when the most recent message was sent in this channel. Null if no messages have been sent. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' resolved_at: description: >- The timestamp when the linked support ticket was marked as resolved. Null if unresolved or not a support chat. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' required: - id - company_id - custom_name - customer_user - resolved_at - last_message_at type: object PageInfo: description: Information about pagination in a connection. properties: end_cursor: description: When paginating forwards, the cursor to continue. type: - string - 'null' has_next_page: description: When paginating forwards, are there more items? type: boolean has_previous_page: description: When paginating backwards, are there more items? type: boolean start_cursor: description: When paginating backwards, the cursor to continue. type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````