Get all Account Memberships

GET 
/v2/accounts/:accountID/account-memberships

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

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

accountID stringrequired

The ID of the account for which you want to get the list of unassigned account members.

Query Parameters

filter string

Specifies the filter attributes.

sort string

Supported attributes are created_at, email, id, name, or updated_at. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with -, for example, -updated_at. The default sort order is created_at in descending order. For more information, see Sorting.

page[limit] int64

The number of records per page.

page[offset] int64

Possible values: <= 10000

The number of records to offset the results by.

include string

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

Responses

200

OK

application/json

Schema

Schema

data AccountMembershipResponse[]
Array [
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.
]
meta object

page object

limit integer

The maximum number of records per page for this response. You can set this value up to 100.

current integer

The current page.

offset integer

The current offset by number of records, not pages. Offset is zero-based.

total integer

The total page count.

results object

total integer

The total number of results after applying filters, if any, or all results.

links object

current uri

Always the current page.

first uri

Always the first page.

last uri

Always null if there is only one page.

next string

Always null if there is only one page.

prev string

Always null if the user is on the first page.

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"
      }
    }
  ],
  "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 [
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"
    }
  ]
}

Loading...