Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
members
public

List Members

List members with optional customer ID filter.

Scopes: members:read members:write

get/v1/members/

Query parameters

customer_idstring nullable

Filter by customer ID.

Filter by customer ID.

external_customer_idstring nullable

The customer external ID.

Filter by customer external ID.

role'owner' | 'billing_manager' | 'member'

Filter by member role.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

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

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

sortingMemberSortProperty[] 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.

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.

Response

Successful Response

Example response

{
  "items": [
    {
      "email": "member@example.com",
      "name": "Jane Doe",
      "external_id": "usr_1337"
    }
  ]
}