ClientsResponse
Response schema for multiple clients
data object[]required
A list of clients
Time at which the object was created.
The client's email address. This field is only included if include_sensitive is true.
The client's first name. This field is only included if include_sensitive is true.
Unique identifier for the object.
Possible values: Value must match regular expression ^clnt_\w{12}$
The client's last name. This field is only included if include_sensitive is true.
The locale of the client.
en-USString representing the object's type.
Possible values: [client]
The client's phone number (E.164 format). This field is only included if include_sensitive is true.
External reference identifier for the client.
The client's time zone (IANA format).
America/ChicagoTime at which the object was last updated.
meta objectrequired
Metadata for paginated responses
Current page number
Number of records per page
Total number of records
Total number of pages
{
"data": [
{
"created_at": "2025-01-15T14:30:00Z",
"email": "jane.smith@example.com",
"first_name": "Jane",
"id": "clnt_a1b2c3d4e5f6",
"last_name": "Smith",
"locale": "en-US",
"object": "client",
"phone": "+15551234567",
"reference_id": "ext_12345",
"time_zone": "America/Chicago",
"updated_at": "2025-03-10T09:45:00Z"
}
],
"meta": {
"current_page": 1,
"page_size": 10,
"total_count": 50,
"total_pages": 5
}
}