[GET] Number details

This API is used to get meta-data of listed business numbers like their updated at, created by etc.

Get Numbers

This endpoint returns all numbers under a client account. It supports pagination and filtering based on department/operation/process/feature_set. You can only pass one filter at a time. It will return an empty array if no numbers are found.

GET/clients/{clientAccountId}/number_management/numbers

Authorization

Path parameters

client_account_id*string

Client Account ID of the caller, taken from path params

Query parameters

department_idstring

Department ID - to filter by department

feature_set_idstring

Feature Set ID - to filter by feature set

operation_idstring

Operation ID - to filter by operation

process_idstring

Process ID - to filter by process or subprocess

limitinteger (int64)

Limit per page

pageinteger (int64)

Current page number

Response

Body

numbersarray of PhoneNumbersResponse (object)

business_profilestring

call_me_backstring

call_reasonstring

client_account_idstring

created_atstring (date-time)

created_by_emailstring

departmentstring

feature_set_namestring

label_categorystring

label_namestring

operationstring

phone_numberstring

phone_typestring

processstring

statusstring

subprocessstring

updated_atstring (date-time)

video_caller_idstring

pagination_informationPaginationInfo (object)

total_page_countinteger (int64)

Request

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

Response

{
  "numbers": [
    {
      "business_profile": "text",
      "call_me_back": "text",
      "call_reason": "text",
      "client_account_id": "text",
      "created_at": "2024-11-21T15:42:06.527Z",
      "created_by_email": "text",
      "department": "text",
      "feature_set_name": "text",
      "label_category": "text",
      "label_name": "text",
      "operation": "text",
      "phone_number": "text",
      "phone_type": "text",
      "process": "text",
      "status": "text",
      "subprocess": "text",
      "updated_at": "2024-11-21T15:42:06.527Z",
      "video_caller_id": "text"
    }
  ],
  "pagination_information": {}
}

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

Get Numbers

GET/clients/{clientAccountId}/number_management/numbers

Authorization

Path parameters

client_account_id*string

Client Account ID of the caller, taken from path params

Query parameters

department_idstring

Department ID - to filter by department

feature_set_idstring

Feature Set ID - to filter by feature set

operation_idstring

Operation ID - to filter by operation

process_idstring

Process ID - to filter by process or subprocess

limitinteger (int64)

Limit per page

pageinteger (int64)

Current page number

Response

Body

numbersarray of PhoneNumbersResponse (object)

business_profilestring

call_me_backstring

call_reasonstring

client_account_idstring

created_atstring (date-time)

created_by_emailstring

departmentstring

feature_set_namestring

label_categorystring

label_namestring

operationstring

phone_numberstring

phone_typestring

processstring

statusstring

subprocessstring

updated_atstring (date-time)

video_caller_idstring

pagination_informationPaginationInfo (object)

total_page_countinteger (int64)

Request

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

Response

{
  "numbers": [
    {
      "business_profile": "text",
      "call_me_back": "text",
      "call_reason": "text",
      "client_account_id": "text",
      "created_at": "2024-11-21T15:42:06.527Z",
      "created_by_email": "text",
      "department": "text",
      "feature_set_name": "text",
      "label_category": "text",
      "label_name": "text",
      "operation": "text",
      "phone_number": "text",
      "phone_type": "text",
      "process": "text",
      "status": "text",
      "subprocess": "text",
      "updated_at": "2024-11-21T15:42:06.527Z",
      "video_caller_id": "text"
    }
  ],
  "pagination_information": {}
}