Skip to main content

Prerequisites

  • Your Cconnect deployment has Customer API v1 enabled.
  • Your company has the required product entitlement: Desk for tickets, Chat for conversations.
  • Your administrator has issued a valid API credential.
  • Your administrator has confirmed the API base URL in the generated specification.

Configure your client

Store your credential in your integration’s secret manager. For a local test, set shell variables using your own values:
Never place the token in a URL, browser storage, source control, screenshots, or support messages.

Verify your identity

The data object identifies your company, credential, scopes, and current products. This endpoint accepts any valid customer credential. It does not require a member session cookie.

Read tickets

A credential with tickets:read and a company with Desk entitlement can list tickets:
An empty data array is a successful response when there are no matching tickets. Use meta.has_more to continue to the next page.

Choose the next operation

Read the ticket synchronization guide, then inspect the matching operation in the API reference tab. The portal initially provides copyable examples; it does not execute production requests through the browser playground. Use a separate test company for integration development. This release does not provide an automatically provisioned sandbox. If a request fails, inspect the HTTP status, the structured error, and X-Request-Id before retrying.