List all membership profiles
How to fetch a collection of membership profiles via API
To fetch a collection of membership profiles, send a GET request to the /api/membership_profiles endpoint.
Request
GET https://provisioning.commercelayer.io/api/membership_profiles
Example
The following request fetches a collection of membership profiles:
curl -g -X GET \
'https://provisioning.commercelayer.io/api/membership_profiles/' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer {{your_access_token}}'On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:
{
"data": [
{
"id": "xYZkjABcde",
"type": "membership_profiles",
"links": {
"self": "https://provisioning.commercelayer.io/api/membership_profiles/xYZkjABcde"
},
"attributes": {
"name": "Marketing group",
"test_enabled": false,
"access_scope": "live_access",
"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/membership_profiles/xYZkjABcde/relationships/organization",
"related": "https://provisioning.commercelayer.io/api/membership_profiles/xYZkjABcde/organization"
}
},
"application_memberships": {
"links": {
"self": "https://provisioning.commercelayer.io/api/membership_profiles/xYZkjABcde/relationships/application_memberships",
"related": "https://provisioning.commercelayer.io/api/membership_profiles/xYZkjABcde/application_memberships"
}
}
}
},
{
"other": "... 9 membership_profiles (first page)"
}
],
"meta": {
"record_count": 140,
"page_count": 14
},
"links": {
"first": "https://provisioning.commercelayer.io/membership_profiles?page[number]=1&page[size]=10",
"next": "https://provisioning.commercelayer.io/membership_profiles?page[number]=2&page[size]=10",
"last": "https://provisioning.commercelayer.io/membership_profiles?page[number]=14&page[size]=10"
}
}Remember that when you fetch a list of resources you get paginated result.
Sortable fields
The list of membership profiles can be sorted by the following fields:
nameidcreated_atupdated_atreferencereference_origin
Filterable fields
The list of membership profiles can be filtered by the following fields:
Attributes
nameaccess_scopeidcreated_atupdated_atreferencereference_originmetadata
Relationships
organizationapplication_memberships
Last updated

