[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

Bearer

Path parameters

client_account_id*string

Client Account ID of the caller, taken from path params

Query parameters

Response

200400401500

Body

application/json

numbersarray of PhoneNumbersResponse (object)

pagination_informationPaginationInfo (object)

Request

JavaScriptCurlPython

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

Response

200400401500

{
  "numbers": [
    {
      "business_profile": "text",
      "call_me_back": "text",
      "call_reason": "text",
      "client_account_id": "text",
      "created_at": "2024-11-21T11:24:52.628Z",
      "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-21T11:24:52.628Z",
      "video_caller_id": "text"
    }
  ],
  "pagination_information": {}
}

Process / Subprocess ID & feature-set ID can be copied from self-serve console.

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