Retrieve Customers V3

get

https://api-sandbox.thisisbud.com/platform/v3/customers

This endpoint is used to list customers associated with the current project.

Customers are listed ordered by their ID. Deleted customers will not be included in the list.

The list of customers can be filtered by creation date with the date_from and date_to query parameters, which expect dates in the RFC3339 format.

If more results pages are available, the response metadata object will contain a next_page_token field which can be used to fetch the next page of results. The token should be provided in the page_token query parameter for subsequent requests.

For more information on how to manage your Bud Customers, please, refer to the following guide

Query Params

date_from

string

Date (RFC3339) to filter customers created on or after which. To maintain backwards compatibility, dates in the format (YYYY-MM-DD) can also be used and will be assumed to be UTC.

date_to

string

Date (RFC3339) to filter customers created on or before which. To maintain backwards compatibility, dates in the format (YYYY-MM-DD) can also be used and will be assumed to be UTC. Uses the current date by default.

page_size

integer

1 to 1000

Maximum number of results to be returned. Defaults to 200, maximum is 1000.

page_token

string

The token required to fetch a specific page of results. Provided by the next_page_token field in the previous request.

idempotent_identifier

string

Filter by the internal client identifier provided in the client_metadata object when creating the customer in Create Customer V3. Only one customer will be returned if one is found with the given identifier.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

Responses

401

An unauthenticated request was received.

405

The request uses an unexpected HTTP method.

5XX

An unexpected error occurred on the server side.

200Returns a list of customers.

400The request contains an invalid parameter.