List Customers

Required permissions: customers.read.*

Authorizations

X-Access-Key-Id

string

headerrequired

X-Access-Key-Secret

string

headerrequired

Query Parameters

page_size

integer

Maximum number of items in a page.

page

integer

Page number of query.

with_trashed

boolean

Whether or not deleted items are included.

order_by

string

Attribute to order query by.

order_direction

enum<string>

Direction to order query by.

Available options:

asc,

desc

value

string

Value of attribute to filter query by.

operator

enum<string>

Comparison operator to filter query by.

Available options:

Equal,

NotEqual,

Contains,

GreaterThan,

GreaterThanOrEqual,

LessThan,

LessThanOrEqual,

IsNull,

NotNull

on

string

Attribute to filter query by

Response

200 - application/json

message

string

required

data

object[]

required

A list of Customer resource objects.

Show child attributes

data.id

integer

required

data.first_name

string | null

required

Maximum length: 255

data.middle_name

string | null

required

Maximum length: 255

data.last_name

string | null

required

Maximum length: 255

data.email

string | null

required

Maximum length: 255

data.contact_number

string | null

required

In E.164 format.

data.address

object

required

Show child attributes

data.address.line_1

string | null

Maximum length: 255

data.address.line_2

string | null

Maximum length: 255

data.address.city

string | null

Maximum length: 255

data.address.region

string | null

Maximum length: 255

data.address.region_code

string | null

Maximum length: 255

data.address.country

string | null

Maximum length: 255

data.address.country_code

string | null

Maximum length: 255

data.address.postal_code

string | null

Maximum length: 255

data.name

string

data.created_at

string

required

data.updated_at

string

required

data.deleted_at

string | null

current_page

integer

required

Current page number.

first_page_url

string

required

URL to fetch the first page.

from

integer | null

required

last_page

integer

required

Last page number.

last_page_url

string

required

URL to fetch the last page.

next_page_url

string | null

required

URL to fetch the next page.

path

string

required

Current URL.

per_page

integer

required

Number of items per page.

prev_page_url

string | null

required

URL to fetch the next page.

to

integer | null

required

total

integer

required

Total number of items.