Listing

GET/api/v1/tickets

This endpoint allows you to retrieve a paginated list of all your tickets. By default, a maximum of ten tickets are shown per page.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Query Params

pagenumberoptional
Page number for pagination.
pageSizenumberoptional
Number of tickets to return per page.
selectedDatestringoptional
Filter tickets by date range.
ticketNumberstringoptional
Filter tickets by ticket number.
keywordstringoptional
Search tickets by keyword.
titlestringoptional
Filter tickets by title.
descriptionstringoptional
Filter tickets by description.
statusarray[string]optional
Filter tickets by status.
priorityarray[string]optional
Filter tickets by priority level.
channelarray[string]optional
Filter tickets by channel.
typearray[string]optional
Filter tickets by type.
ticketTypearray[string]optional
Filter tickets by ticket type.
contactarray[string]optional
Filter tickets by associated contact.
tagsarray[string]optional
Filter tickets by associated tags.
categoriesarray[string]optional
Filter tickets by categories.
assigneearray[string]optional
Filter tickets by assigned agent.
customFieldsstringoptional
Filter tickets by custom fields. Each object should contain attributeId, type, and value.

Responses

200

totalintegerrequired
pageintegerrequired
pageSizeintegerrequired
lastPageintegerrequired
dataarray[object]required
Child attributes
- idstringrequired
- createdAtstringrequired
- updatedAtstringrequired
- deletedAtnullrequired
- titlestringrequired
- descriptionstringrequired
- typestringrequired
- channelstringrequired
- prioritystringrequired
- statusstringrequired
- contactIdstringrequired
- creatorIdstringrequired
- assigneeIdstringrequired
- reasonToAssignstringrequired
- ticketNumberintegerrequired
- assigneeobjectoptional
  Child attributes
  idstringrequired
  createdAtstringrequired
  updatedAtstringrequired
  deletedAtnullrequired
  namestringrequired
  emailstringrequired
  addressnullrequired
  phonestringrequired
  notificationCountnullrequired
  providernullrequired
  providerIdnullrequired
  firstNamenullrequired
  lastNamenullrequired
- contactobjectoptional
  Child attributes
  idstringrequired
  createdAtstringrequired
  updatedAtstringrequired
  deletedAtnullrequired
  namestringrequired
  addressstringrequired
  channelstringrequired
  notesstringrequired
  contactNumberintegerrequired
  companyIdnullrequired
  contactProfilestringrequired
  socialProfileUrlnullrequired
- creatorobjectoptional
  Child attributes
  idstringrequired
  createdAtstringrequired
  updatedAtstringrequired
  deletedAtnullrequired
  namestringrequired
  emailstringrequired
  addressnullrequired
  phonestringrequired
  notificationCountintegerrequired
  providernullrequired
  providerIdnullrequired
  firstNamenullrequired
  lastNamenullrequired
- categoriesarray[string]optional
- tagsarray[object]optional
  Child attributes
  idstringoptional
  createdAtstringoptional
  updatedAtstringoptional
  deletedAtnulloptional
  namestringoptional
  positionintegeroptional
- customFieldsarray[object]optional
  Child attributes
  idstringoptional
  createdAtstringoptional
  updatedAtstringoptional
  deletedAtnulloptional
  textValuestringoptional
  booleanValuenulloptional
  numberValuenulloptional
  dateValuenulloptional
  entityIdstringoptional
  attributeIdstringoptional
  attributeobjectoptional
  Child attributes
  idstringrequired
  createdAtstringrequired
  updatedAtstringrequired
  deletedAtnullrequired
  systemNamestringrequired
  displayNamestringrequired
  typestringrequired
  positionintegerrequired
  isDefaultbooleanrequired
  isArchivedbooleanrequired
  isRequiredbooleanrequired
  isUniquebooleanrequired
  groupIdstringrequired
  uploadsarray[string]optional

Request

curl -X GET "https://apigw.klinkcx.com/api/v1/tickets" \
  -H "Authorization: Bearer {token}"

Response

{
  "total": 100,
  "page": 1,
  "pageSize": 10,
  "lastPage": 1,
  "data": [
    {
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null,
      "title": "string",
      "description": "string",
      "type": "string",
      "channel": "string",
      "priority": "string",
      "status": "string",
      "contactId": "string",
      "creatorId": "string",
      "assigneeId": "string",
      "reasonToAssign": "string",
      "ticketNumber": 38838,
      "assignee": {
        "id": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "deletedAt": null,
        "name": "string",
        "email": "string",
        "address": null,
        "phone": "string",
        "notificationCount": null,
        "provider": null,
        "providerId": null,
        "firstName": null,
        "lastName": null
      },
      "contact": {
        "id": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "deletedAt": null,
        "name": "string",
        "address": "string",
        "channel": "string",
        "notes": "string",
        "contactNumber": 23423,
        "companyId": null,
        "contactProfile": "string",
        "socialProfileUrl": null
      },
      "creator": {
        "id": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "deletedAt": null,
        "name": "string",
        "email": "string",
        "address": null,
        "phone": "string",
        "notificationCount": 2,
        "provider": null,
        "providerId": null,
        "firstName": null,
        "lastName": null
      },
      "categories": [],
      "tags": [
        {
          "id": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "deletedAt": null,
          "name": "string",
          "position": 1
        }
      ],
      "customFields": [
        {
          "id": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "deletedAt": null,
          "textValue": "string",
          "booleanValue": null,
          "numberValue": null,
          "dateValue": null,
          "entityId": "string",
          "attributeId": "string",
          "attribute": {
            "id": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "deletedAt": null,
            "systemName": "string",
            "displayName": "string",
            "type": "string",
            "position": 1,
            "isDefault": false,
            "isArchived": false,
            "isRequired": false,
            "isUnique": false,
            "groupId": "string"
          },
          "uploads": []
        }
      ]
    },
    {
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null,
      "title": "string",
      "description": "string",
      "type": "string",
      "channel": "string",
      "priority": "string",
      "status": "string",
      "contactId": "string",
      "creatorId": "string",
      "assigneeId": "string",
      "reasonToAssign": "string",
      "ticketNumber": 323
    }
  ]
}