Skip to main content
GET
List customers

Authorizations

x-api-key
string
header
required

Query Parameters

cursor
string

Opaque cursor from a previous response. Send meta.nextCursor with direction=forward to read the next page, or meta.previousCursor with direction=backward to read the previous page.

limit
number
default:20

Maximum number of results to return (1-100)

Required range: 1 <= x <= 100
direction
enum<string>

Which side of the cursor to read: forward returns the rows after it, backward the rows before it. Rows come back in list order either way. Without a cursor, forward starts at the first row and backward at the end of the list.

Available options:
forward,
backward

Case-insensitive substring match on the business legal name and trade name, and on the individual full name or first and last name.

clientReferenceId
string

Filter to the customer with this client reference ID. 1-255 characters from A-Za-z, 0-9, underscore, hyphen, colon, and period — no spaces.

type
enum<string>[]

Filter by one or more customer types.

Available options:
business,
individual
sortBy
enum<string>
Available options:
createdAt,
updatedAt,
type
sortOrder
enum<string>
Available options:
asc,
desc

Response

data
object[]
required
meta
object
required