Skip to main content
GET
/
customers
Retrieve all customers with pagination
curl --request GET \
  --url https://api.example.com/customers \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Acme Corp",
    "sendingPhoneNumber": "+1234567890",
    "smsMessagingProfileId": "msg_prof_123",
    "smsBearerToken": "sms_token_xyz",
    "createdAt": "2023-01-01T12:00:00Z",
    "updatedAt": "2023-01-01T12:00:00Z"
  },
  {
    "id": "223e4567-e89b-12d3-a456-426614174001",
    "name": "Beta LLC",
    "sendingPhoneNumber": "+1987654321",
    "smsMessagingProfileId": "msg_prof_456",
    "smsBearerToken": "sms_token_abc",
    "createdAt": "2023-02-01T12:00:00Z",
    "updatedAt": "2023-02-01T12:00:00Z"
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer<int32>
required

Page number to retrieve (starts from 1)

Required range: x >= 1
Example:

1

​
pageSize
integer<int32>
required

Number of items to return per page

Required range: 1 <= x <= 100
Example:

20

Response

List of customers retrieved successfully

​
id
string<uuid>

Unique identifier for the customer

​
name
string

Name of the customer organization

​
sendingPhoneNumber
string

Primary phone number used for sending messages

​
smsMessagingProfileId
string

Identifier for the SMS messaging profile

​
smsBearerToken
string

Bearer token for authenticating SMS requests

​
createdAt
string<date-time>

Timestamp when the customer account was created

​
updatedAt
string<date-time>

Timestamp when the customer account was last updated