List Contacts

Retrieve a paginated list of contacts from your address book. This endpoint supports sorting and pagination to help you efficiently browse or sync contact data.

This endpoint is read-only and does not modify contact data.

GET /addressbook/contacts

Required Permission

read:Contacts

Your API key must have this permission enabled in order to use this endpoint.

Example Request

curl --location 'https://<hostname>/addressbook/contacts?sortField=created_on&sortDir=DESC&offset=0&limit=10' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace YOUR_API_KEY with your API key.

All endpoints shown in this documentation use a sample base URL. The production API endpoint is provided by our team upon request.

Request Parameters

Field	Type	Required	Description
sortField	string	No	Field to sort by (e.g. created_on).
sortDir	string	No	Sort direction: ASC or DESC.
offset	number	No	Number of records to skip (for pagination).
limit	number	No	Maximum number of records to return.

Responses

Success (HTTP 200)

{
  "success": true,
  "records": [
    {
      "id": "3392287d-7a79-4789-9ef8-7dc174836688",
      "alias": "john",
      "msisdn": "4479000000001",
      "created_on": "2025-11-10T20:15:12.000Z"
    }
  ],
  "offset": 0,
  "limit": 10,
  "total": 128
}

The response includes:

• A list of contact records

• Pagination metadata for navigating large address books

This endpoint supports sorting and pagination. See Search & Pagination Parameters for details.