Get a List of Account Memberships of Account Member

GET 
https://useast.api.elasticpath.com/v2/account-members/:accountMemberId/account-memberships

You can also use include=account to retrieve details about the accounts associated with the account memberships. For more information see including resources.

You can use pagination with this resource. For more information, see pagination.

Filtering

The following operators and attributes are available for filtering account memberships.

Operator	Description
eq	Checks whether the values of two operands are equal. If the values are equal, the condition is true.
like	Checks if the operand contains the specified string. You can use wildcard characters in operand.

Attribute	Type	Operator	Example
account_member_id	string	eq / like	eq(account_member_id,00000000-0000-1000-8000-0000000)

Request

Path Parameters

accountMemberId uuidrequired

The ID of the account member for which you want to list the memberships.

Query Parameters

filter string

Specifies the filter attributes.

include string

Parameter to retrieve more information about any related resources like accounts.

Responses

200

OK

application/json

Schema

Schema

data AccountMembershipResponseUsingAccountMemberId[]
Array [
iduuid
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 account is created.
Example: 2021-02-23T09:40:33.882Z
updated_atstring
The date the account is updated.
Example: 2021-02-23T09:40:33.882Z
relationships object
account object
data object
iduuid
Specifies the ID of the account.
Example: 908f7849-60da-4e4a-a3b1-51d4cbe3b953
typestring
Specifies the type of the Account.
Default value: account
links object
selfuri
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
]
meta object
page object
limitinteger
The maximum number of records per page for this response. You can set this value up to 100.
Example: 25
currentinteger
The current page.
Example: 0
offsetinteger
The current offset by number of records, not pages. Offset is zero-based.
Example: 0
totalinteger
The total page count.
Example: 1
results object
totalinteger
The total number of results after applying filters, if any, or all results.
Example: 1
links object
currenturi
Always the current page.
Example: https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships?page[offset]=0&page[limit]=25
firsturi
Always the first page.
Example: https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships?page[offset]=0&page[limit]=25
lasturi
Always null if there is only one page.
Example: https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships?page[offset]=0&page[limit]=25
nextstring
Always null if there is only one page.
Example: null
prevstring
Always null if the user is on the first page.
Example: null

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": {
          "data": {
            "id": "908f7849-60da-4e4a-a3b1-51d4cbe3b953",
            "type": "account"
          }
        }
      },
      "links": {
        "self": "https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships/24e939f6-178f-497b-9d64-5bf2b5a70a2e"
      }
    }
  ],
  "meta": {
    "page": {
      "limit": 25,
      "current": 0,
      "offset": 0,
      "total": 1
    },
    "results": {
      "total": 1
    }
  },
  "links": {
    "current": "https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships?page[offset]=0&page[limit]=25",
    "first": "https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships?page[offset]=0&page[limit]=25",
    "last": "https://useast.api.elasticpath.com/v2/accounts/5b495058-9ffc-4b9b-810a-c9d43ffc6500/account-memberships?page[offset]=0&page[limit]=25",
    "next": null,
    "prev": null
  }
}

404

Not Found

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
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 Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
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/account-members/:accountMemberId/account-memberships");
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

accountMemberId — pathrequired

filter — query

include — query

ResponseClear

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