POpolar
customers
public

List Customers

Changed on

List customers.

Scopes: customers:read customers:write

get/v1/customers/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/customers/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: customers:read, customers:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737
emailstring nullable

Filter by exact email.

querystring nullable

Filter by name, email, or external ID.

activeboolean nullable

Filter by active customers, i.e. customers with at least one trialing, active or past_due subscription.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingCustomerSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

metadataMetadataQuery nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response

itemsCustomer[] required(unresolved $ref)

Changes

  • f9688fd328d6Revision changes
    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status