List tickets

Returns a paginated list of support tickets. Deleted tickets are excluded. Read-only: tickets cannot be created or modified through the public API.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Query Parameters

pageinteger

Page number

Default: 1

limitinteger

Items per page (max 100)

Default: 20Maximum: 100

searchstring

Search term

statusstring

Exact status match, e.g. open or resolved.

prioritystring

typestring

assigneestring

Company user id the ticket is assigned to.

curl -X GET "https://clientsphere.io/api/v1/tickets?page=1&limit=20&search=%3Cstring%3E&status=%3Cstring%3E&priority=%3Cstring%3E&type=%3Cstring%3E&assignee=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Paginated list of tickets

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "title": "string",
      "description": "string",
      "priority": "high",
      "status": "open",
      "type": "support",
      "module": "string",
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
      "supportChannelId": "5a1976e8-09c2-498a-bee2-379b8cdcc638",
      "assignedTo": 0,
      "createdBy": 0,
      "resolution": "string",
      "slaDeadline": "2019-08-24T14:15:22Z",
      "firstReplyAt": "2019-08-24T14:15:22Z",
      "slaBreachedAt": "2019-08-24T14:15:22Z",
      "followUpDueAt": "2019-08-24T14:15:22Z",
      "lastCustomerMessageAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 137,
      "totalPages": 7
    }
  }
}

List tickets

Authorization

Query Parameters

Response

TypeScript