Get customers
Use this endpoint to get a paginated list of customers.
By specifying the query parameters offset and limit, you can narrow down the search results. You can also sort the results in an ascending or descending order. Additionally, with the isDeleted query parameter, you can filter for either deleted or non-deleted customers. When no query parameter is specified, by default, you get up to 10 records.
Authorizations
The access token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
A UUID of the request.
Query Parameters
The number of records to skip before returning records. For example, when offset is 20 and limit's 10, this endpoint returns records from 21 to 30.
The maximum number of records in a single page.
The criteria to sort results, where - indicates a descending order and + indicates an ascending order. You can apply sorting to the following fields - createdAt, updatedAt, firstName, lastName, emailAddress and status.
A flag indicating whether only the deleted customers need to be included. Set to true to include only the deleted customers and false to exclude deleted customers.
Response
The list of customers.
The pagination criteria.
Was this page helpful?