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 uuidrequired

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

membershipID uuidrequired

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 object
idstring<uuid>
Represents the unique identifier for the account membership.
Example: 24e939f6-178f-497b-9d64-5bf2b5a70a2e
typestring
Represents the type of the object returned.
Default value: account_membership
meta object
timestamps object
created_atstring
The date the resource is created.
Example: 2021-02-23T09:40:33.882Z
updated_atstring
The date the resource is updated.
Example: 2021-02-23T09:40:33.882Z
relationships object
account_member object
data object
idstring<uuid>
Specifies the ID of the account member.
Example: 908f7849-60da-4e4a-a3b1-51d4cbe3b953
typestring
Specifies the type of the account member.
Default value: account_member
links object
selfstring<uri>
A URL to the specific resource.
Example: https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e

Example (auto)

{
  "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 object[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring<string>required
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 object[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring<string>required
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/:membershipID");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

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!