Customers

Get all customers

Changed on

Returns all customers filtered by identifiers, emails, names and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/customers/getAll

Request

  • Base URL: https://api.mews.com
  • URL: https://api.mews.com/api/connector/v1/customers/getAll
  • Auth: none declared

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

ChainIdsstring[] nullable

Unique identifiers of the chains. Required when using Portfolio Access Tokens, ignored otherwise.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted or both records.

CustomerIdsstring[] nullable

Unique identifiers of Customers. Required if no other filter is provided.

CompanyIdsstring[] nullable

Unique identifier of the Company the customer is associated with.

Emailsstring[] nullable

Emails of the Customers.

FirstNamesstring[] nullable

First names of the Customers.

LastNamesstring[] nullable

Last names of the Customers.

LoyaltyCodesstring[] nullable

Loyalty codes of the Customers.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last and hence oldest customer item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older customers. If Limitation is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.

Changes