Retrieve a membership

How to fetch a specific membership via API

To fetch a single membership, send a GET request to the /api/memberships/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

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

Example

Request

The following request fetches the membership identified by the id "xYZkjABcde":

curl -g -X GET \
  'https://provisioning.commercelayer.io/api/memberships/xYZkjABcde' \
  -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 single resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "memberships",
    "links": {
      "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde"
    },
    "attributes": {
      "user_email": "[email protected]",
      "user_first_name": "John",
      "user_last_name": "Doe",
      "status": "pending",
      "owner": true,
      "test_enabled": false,
      "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"
        }
      },
      "membership_profile": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/relationships/membership_profile",
          "related": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/membership_profile"
        }
      },
      "versions": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/relationships/versions",
          "related": "https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/versions"
        }
      }
    }
  }
}