Listing

GET/api/v1/channels

This endpoint allows you to retrieve a paginated list of all your channel. By default, a maximum of ten channel 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

keywordstringoptional
Search the channels by keywords. You cannot search with a substring. For example, a channel "Kyaw Kyaw" can be looked up using "kyaw", "Kya", "yaw" and "aw".

Responses

200

requestIdstringrequired
pageintegerrequired
pageSizeintegerrequired
lastPageintegerrequired
totalintegerrequired
dataarray[object]required
Child attributes
- idstringoptional
- createdAtstringoptional
- updatedAtstringoptional
- deletedAtnulloptional
- namestringoptional
- typestringoptional
- brandNamestringoptional

Request

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

Response

{
  "requestId": "557520e4-7197-4d56-8a24-ee8c2782d6e4",
  "page": 1,
  "pageSize": 10,
  "lastPage": 8,
  "total": 73
    "data":[
      {
      "id": "f6154dda-bd9a-4d03-8a77-ff3421070009",
      "createdAt": "2025-03-02T16:42:53.796Z",
      "updatedAt": "2025-03-02T16:42:54.078Z",
      "deletedAt": null,
      "name": "K-Link BSS UAT DEMO KURO",
      "type": "line",
      "brandName": "K-Link BSS UAT DEMO KURO"
    },
    {
      "id": ...............
    }
  ]
}