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

Request

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}}'

Response

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "xYZkjABcde",
      "type": "memberships",
      "links": {
        "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde"
      },
      "attributes": {
        "user_email": "[e-mail]",
        "user_first_name": "John",
        "user_last_name": "Doe",
        "status": "pending",
        "owner": true,
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "organization": {
          "links": {
            "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/relationships/organization",
            "related": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/organization"
          }
        },
        "role": {
          "links": {
            "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/relationships/role",
            "related": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/role"
          }
        },
        "application_memberships": {
          "links": {
            "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/relationships/application_memberships",
            "related": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/application_memberships"
          }
        },
        "versions": {
          "links": {
            "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/relationships/versions",
            "related": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/versions"
          }
        }
      }
    },
    {
      "other": "... 9 memberships (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://provisioning.commercelayer.io/memberships?page[number]=1&page[size]=10",
    "next": "https://provisioning.commercelayer.io/memberships?page[number]=2&page[size]=10",
    "last": "https://provisioning.commercelayer.io/memberships?page[number]=14&page[size]=10"
  }
}

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