Retrieve an application membership

How to fetch a specific application membership via API

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

Request

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

Example

Request

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

curl -g -X GET \
  'https://provisioning.commercelayer.io/api/application_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": "application_memberships",
    "links": {
      "self": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde"
    },
    "attributes": {
      "filters": {
        "market_id_in": [
          202,
          203
        ]
      },
      "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": {
      "api_credential": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/relationships/api_credential",
          "related": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/api_credential"
        }
      },
      "membership": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/relationships/membership",
          "related": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/membership"
        }
      },
      "membership_profile": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/relationships/membership_profile",
          "related": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/membership_profile"
        }
      },
      "organization": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/relationships/organization",
          "related": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/organization"
        }
      },
      "role": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/relationships/role",
          "related": "https://provisioning.commercelayer.io/api/application_memberships/xYZkjABcde/role"
        }
      }
    }
  }
}