Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Account Membership API

The `Account Membership` resource represents the relationship between an account and an account member. This relationship is many to many. Each account can have multiple account members, and each account member can be a member of multiple accounts.

Elastic Path Account Membership API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account Membership. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

7 operations 4 paths 12 schemas 1 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Account Membership API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Account Membership 7

The Account Membership resource represents the relationship between an account and an account member. This relationship is many to many. Each account can have multiple account mem…

POST
/v2/accounts/{accountID}/account-memberships
Create an Account Membership
post-v2-accounts-accountID-account-memberships 1 param body → 201400404409422500
GET
/v2/accounts/{accountID}/account-memberships
Get all Account Memberships
get-v2-accounts-accountID-account-memberships 6 params → 200400404500
GET
/v2/account-members/{accountMemberId}/account-memberships
Get a List of Account Memberships of Account Member
get-v2-account-members-accountMemberId-account-memberships 4 params → 200400404500
GET
/v2/accounts/{accountID}/account-memberships/unassigned-account-members
Get a List of Unassigned Account Members
get-v2-accounts-accountID-account-memberships-unassigned-account-members 5 params → 200400404409500
GET
/v2/accounts/{accountID}/account-memberships/{membershipID}
Get an Account Membership
get-v2-accounts-accountID-account-memberships-membershipID 3 params → 200404500
PUT
/v2/accounts/{accountID}/account-memberships/{membershipID}
Update an Account Membership
put-v2-accounts-accountID-account-memberships-membershipID 2 params body → 200400404409500
DELETE
/v2/accounts/{accountID}/account-memberships/{membershipID}
Delete an Account Membership
delete-v2-accounts-accountID-account-memberships-membershipID 2 params → 204404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AccountMember (7 properties), AccountMembershipResponseUsingAccountMemberId (5 properties), AccountMembershipResponse (5 properties), MetaListPage (4 properties). Each schema is shown below with its type and property counts.

AccountMember
object
7 properties
AccountMembershipResponseUsingAccountMemberId
object
5 properties
Error
object
3 properties 2 required
MetaListPage
object
4 properties
ErrorResponse
object
1 property 1 required
MetaTimestamps
object
1 property
MetaList
object
2 properties
UUID
string
The unique identifier.
AccountMembershipResponse
object
5 properties
MetaListResults
object
1 property
AccountMemberResponse
AccountMembership
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-account-membership-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API
Elastic Path Authentication Realms API