Get a list of customers

get

https://api.spirii.com/v2/customers

Retrieves a paginated list of customers based on the provided filter criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

Defaults to 50

Filter the total amount of items returned.

offset

integer

Defaults to 0

Skip the first N items in the result set.

sortBy

string

enum

Defaults to id

When set, returned customers will be sorted by one of the available properties, descending if not otherwise specified by sortDirection. When used with createdAt* default is createdAt. When used with updatedAt* default is updatedAt (even if combined with createdAt*).

Allowed:

sortDirection

string

enum

Defaults to desc

When set, returned customers will be sorted either descending or ascending. When used with createdAtFrom or updateAtFrom, default is asc.

Allowed:

string

Search across customer names and IDs. This includes externalId.

customerIds

array of integers

Ids of the customers to return. Other filters (and permissions requirement) will still apply.

customerIds

types

array of strings

Types of the customers to filter. Multiple types can be selected.

types

ownerId

integer

ID of the owner of the customer, also known as parent. This will return direct descendant of the provided customer ID. Only available for filtering if you are the owner or have appropriate permissions.

ownedBy

integer

ID of the owner of the customer, also known as parent. This will return all customers owned by this ownerId. Only available for filtering if you are the owner or have appropriate permissions.

cpoId

integer

ID of the CPO above the customer, also known as Operator. Only available for filtering if you are the CPO or have appropriate permissions.

createdAt

date-time

Creation date of the customer.

createdAtFrom

date-time

Start date for filtering by creation date. When set, filter sortBy defaults to createdAt.

createdAtTo

date-time

End date for filtering by creation date. When set, filter sortBy defaults to createdAt.

updatedAt

date-time

Last update date of the customer.

updatedAtFrom

date-time

Start date for filtering by last update date. When set, filter sortBy defaults to updatedAt.

updatedAtTo

date-time

End date for filtering by last update date. When set, filter sortBy defaults to updatedAt.

Responses

400

Bad Request. An explanation message will be provided.

401

Unauthorized. The requested operation cannot be performed with the current access permissions.

403

Forbidden. Your credentials are missing or not valid. An explanation message will be provided.

500

An unexpected error occurred on the server while processing the request.

502

The request failed due to an error in an upstream service.

200