Client

This is an object representing a client.

created_atstring<date-time>required

Time at which the object was created.

emailstring<email>nullable

The client's email address. This field is only included if include_sensitive is true.

first_namestringnullable

The client's first name. This field is only included if include_sensitive is true.

idstringrequired

Unique identifier for the object.

Possible values: Value must match regular expression ^clnt_\w{12}$

last_namestringnullable

The client's last name. This field is only included if include_sensitive is true.

localestringrequired

The locale of the client.

Example: en-US

objectstringrequired

String representing the object's type.

Possible values: [client]

phonestringnullable

The client's phone number (E.164 format). This field is only included if include_sensitive is true.

reference_idstringnullablerequired

External reference identifier for the client.

time_zonestringrequired

The client's time zone (IANA format).

Example: America/Chicago

updated_atstring<date-time>required

Time at which the object was last updated.

Client

{
  "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"
}