GET customers

rebilly.com

Summary: Retrieve a list of customers
Operation ID: GetCustomerCollection
Auth: unknown
Description

Retrieve a list of customers.

Parameters (8)

Organization-Id (?, header, optional)

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

expand (string, query, optional)

Expand a response to get a full related object included inside of the `_embedded` path in the response. It accepts a comma-separated list of objects to expand. See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.

fields (string, query, optional)

Limit the returned fields to the list specified, separated by comma. Note that id is always returned.

filter (string, query, optional)

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.

limit (integer, query, optional)

The collection items limit.

Constraints: {'minimum': 0, 'maximum': 1000}

offset (integer, query, optional)

The collection items offset.

Constraints: {'minimum': 0}

q (string, query, optional)

The partial search of the text fields.

sort (array, query, optional)

The collection items sort field and order (prefix with "-" for descending sort).

No probe data for this endpoint yet.