Number details

This API is used to get meta-data of listed business numbers.

Replace the {{BaseURL}} with the one mentioned here

GET{{BaseURL}}/clients/{clientAccountId}/number_management/numbers

{clientAccountId} : This can be taken directly from the self serve portal under the Manage API Keys Page

Query Parameters

Name	Value	Type
department_id	optional, to filter by department	string
operation_id	optional, to filter by operation	string
process_id	optional, to filter by process or subprocess	string
feature_set_id	optional, to filter by feature set	string
limit	optional, Limit per page	integer
page	optional, Current page number	integer

For Authorization Token kindly refer the Authentication section followed by Generate Access Token API

Header

Name	Value
Authorization	Required Bearer <token>

Response

200 OK

{
    "numbers": [
        {
            "phone_number": "918848628575230",
            "phone_type": "verified",
            "status": "listed",
            "client_account_id": "91c173bb-28d8-4030-9722-8663ff9589f3",
            "created_by_email": "[email protected]",
            "department": "TestingSanity",
            "operation": "Collections",
            "process": "SanityProcess",
            "subprocess": "",
            "feature_set_name": "New Feature set",
            "call_me_back": "enabled",
            "created_at": "2025-07-28T09:25:19.557139Z",
            "updated_at": "2025-07-28T09:25:23.644159Z",
            "label_name": "testLabel from fs page"
        },
        {
            "phone_number": "918735783247237",
            "phone_type": "verified",
            "status": "listed",
            "client_account_id": "91c173bb-28d8-4030-9722-8663ff9589f3",
            "created_by_email": "[email protected]",
            "department": "TestingSanity",
            "operation": "Collections",
            "process": "SanityProcess",
            "subprocess": "",
            "feature_set_name": "New Feature set",
            "call_me_back": "enabled",
            "created_at": "2025-07-28T09:25:19.557139Z",
            "updated_at": "2025-07-28T09:25:23.671083Z",
            "label_name": "testLabel from fs page"
        }
    ],
    "pagination_information": {
        "total_page_count": 8
    }
}

400 Bad Request

{
    "client_account_id": "91c173bb-28d8-4030-9722-8663ff9589f3",
    "phone_type": "",
    "processing_numbers": [],
    "new_numbers": [
        "911234567891"
    ],
    "other_phonetype_numbers": [],
    "existing_numbers": [],
    "others_numbers": [],
    "invalid_numbers": [],
    "other_feature_set_numbers": [],
    "status": "failed"
}