[GET] Call Personalisation Label

Previously created dynamic labels can be fetched by hitting the below API endpoint.

Base URL : https://enterprise-portal-noneu.truecaller.com

List Dynamic Labels

This endpoint returns all dynamic labels under a client. It supports pagination. It will return an empty array if no labels are found.

GET/clients/{clientAccountId}/labels

Authorization

Path parameters

clientAccountId*string (uuid)

This should be the clientAccountId

Query parameters

pageinteger (int64)

Determines the set of records to return. Defaults to 1.

Example: 1

limitinteger (int64)

Determines the no. of records to be returned. Defaults to 1000.

Example: 1

Header parameters

Acceptstring

Example: "application/vnd.api+json; version=1.0"

Response

Body

categoryinteger (int64)

client_account_idstring

created_atstring (date-time)

created_by_emailstring

deleted_atstring (date-time)

idstring

label_typestring

logo_urlstring

namestring

sub_categoryinteger (int64)

updated_atstring (date-time)

Request

const response = await fetch('/clients/{clientAccountId}/labels', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "client_account_id": "text",
    "created_at": "2024-11-23T08:04:03.036Z",
    "created_by_email": "text",
    "deleted_at": "2024-11-23T08:04:03.036Z",
    "id": "text",
    "label_type": "text",
    "logo_url": "text",
    "name": "text",
    "updated_at": "2024-11-23T08:04:03.036Z"
  }
]

List Dynamic Labels

This endpoint returns all dynamic labels under a client. It supports pagination. It will return an empty array if no labels are found.

GET/clients/{clientAccountId}/labels

Authorization

Path parameters

clientAccountId*string (uuid)

This should be the clientAccountId

Query parameters

pageinteger (int64)

Determines the set of records to return. Defaults to 1.

Example: 1

limitinteger (int64)

Determines the no. of records to be returned. Defaults to 1000.

Example: 1

Header parameters

Acceptstring

Example: "application/vnd.api+json; version=1.0"

Response

Body

categoryinteger (int64)

client_account_idstring

created_atstring (date-time)

created_by_emailstring

deleted_atstring (date-time)

idstring

label_typestring

logo_urlstring

namestring

sub_categoryinteger (int64)

updated_atstring (date-time)

Request

const response = await fetch('/clients/{clientAccountId}/labels', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "client_account_id": "text",
    "created_at": "2024-11-23T08:04:03.036Z",
    "created_by_email": "text",
    "deleted_at": "2024-11-23T08:04:03.036Z",
    "id": "text",
    "label_type": "text",
    "logo_url": "text",
    "name": "text",
    "updated_at": "2024-11-23T08:04:03.036Z"
  }
]