Filter by Contact ID

GET/api/v1/tickets/contact/{id}

Request

Authorization

Bearer Token

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

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

Path Params

idstringrequired
The unique identifier of the contact.

Example:

Query Params

pagenumberoptional
Page number for pagination (default: 1).
pageSizenumberoptional
Number of tickets to return per page (default: 10).

Responses

200

totalintegerrequired
pageintegerrequired
pageSizeintegerrequired
lastPageintegerrequired
dataarray[object]required
Child attributes
- idstringoptional
- createdAtstringoptional
- updatedAtstringoptional
- deletedAtnulloptional
- titlestringoptional
- descriptionstringoptional
- typestringoptional
- channelstringoptional
- prioritystringoptional
- statusstringoptional
- contactIdstringoptional
- creatorIdstringoptional
- assigneeIdstringoptional
- reasonToAssignstringoptional
- ticketNumberintegeroptional
- 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/contact/{id}" \
  -H "Authorization: Bearer {token}"

Response

{
  "total": 32,
  "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": 2323,
      "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": 343,
        "companyId": null,
        "contactProfile": "string",
        "socialProfileUrl": null
      },
      "creator": {
        "id": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "deletedAt": null,
        "name": "string",
        "email": "string",
        "address": null,
        "phone": "string",
        "notificationCount": 23,
        "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": []
        }
      ]
    }
  ]
}