Get an Account Membership

GET 
https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/:membershipID

Get an account membership from an account in your store.

You can also use include=account_member to retrieve details about the account member associated with this account membership. With this option, you can get more information about the account member such as name and email in a single request. For more information see including resources.

Request

Path Parameters

accountID stringrequired

The unique identifier of the account that the account member is associated with.

membershipID stringrequired

The unique identifier of the account membership to update the details of the account member.

Query Parameters

include string

Parameter to retrieve more information about any related resources like account members.

Responses

200

OK

application/json

Schema

Schema

data AccountMembershipResponse

id string

Represents the unique identifier for the account membership.

type string

Default value: account_membership

Represents the type of the object returned.

meta object

timestamps object

created_at string

The date the account is created.

updated_at string

The date the account is updated.

relationships object

account_member object

data object

id string

Specifies the ID of the account member.

type string

Default value: account_member

Specifies the type of the account member.

links object

self uri

A URL to the specific resource.

Example (from schema)

{
  "data": {
    "id": "24e939f6-178f-497b-9d64-5bf2b5a70a2e",
    "type": "account_membership",
    "meta": {
      "timestamps": {
        "created_at": "2021-02-23T09:40:33.882Z",
        "updated_at": "2021-02-23T09:40:33.882Z"
      }
    },
    "relationships": {
      "account_member": {
        "data": {
          "id": "908f7849-60da-4e4a-a3b1-51d4cbe3b953",
          "type": "account_member"
        }
      }
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e"
    }
  }
}

404

Not Found

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

not-found-error

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "account not found"
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/:membershipID' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

accountID — pathrequired

membershipID — pathrequired

include — query

ResponseClear

Click the Send API Request button above and see the response here!