List all memberships

How to fetch a collection of memberships via API

To fetch a collection of memberships, send a GET request to the /api/memberships endpoint.

Request

GET https://provisioning.commercelayer.io/api/memberships

Example

The following request fetches a collection of memberships:

curl -g -X GET \
  'https://provisioning.commercelayer.io/api/memberships/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of memberships can be sorted by the following fields:

  • status

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

The list of memberships can be filtered by the following fields:

Attributes

  • user_email

  • status

  • owner

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • organization

  • role

  • application_memberships

Last updated