Get all Account Members

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

Get all account members contained within your store.

Filtering

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

Attribute	Type	Operator	Example
email	string	eq / like	eq(email,ronswanson@example.com)
name	string	eq / like	like(name,*swan*)

Request

Query Parameters

page[limit] int64

The number of records per page.

page[offset] int64

Possible values: <= 10000

The number of records to offset the results by.

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.

filter string

Specifies the filter attributes.

Responses

200

OK

application/json

Schema

Schema

dataobject[]
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/account-members?page[offset]=0&page[limit]=25
firsturi
Always the first page.
Example: https://useast.api.elasticpath.com/v2/account-members?page[offset]=0&page[limit]=25
lasturi
Always null if there is only one page.
Example: https://useast.api.elasticpath.com/v2/account-members?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": "908f7849-60da-4e4a-a3b1-51d4cbe3b953",
      "type": "account_member",
      "name": "Ron Swanson",
      "email": "ron@swanson.com",
      "meta": {
        "timestamps": {
          "created_at": "2021-02-23T09:40:33.882Z",
          "updated_at": "2021-02-23T09:40:33.882Z"
        }
      },
      "links": {
        "self": "https://useast.api.elasticpath.com/v2/account-members/908f7849-60da-4e4a-a3b1-51d4cbe3b953"
      }
    }
  ],
  "meta": {
    "page": {
      "limit": 25,
      "current": 0,
      "offset": 0,
      "total": 1
    },
    "results": {
      "total": 1
    }
  },
  "links": {
    "current": "https://useast.api.elasticpath.com/v2/account-members?page[offset]=0&page[limit]=25",
    "first": "https://useast.api.elasticpath.com/v2/account-members?page[offset]=0&page[limit]=25",
    "last": "https://useast.api.elasticpath.com/v2/account-members?page[offset]=0&page[limit]=25",
    "next": null,
    "prev": null
  }
}

401

Unauthorized

application/json

Schema

Schema

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

unauthorized-error

{
  "errors": [
    {
      "title": "Unauthorized",
      "status": "401"
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors object[]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");
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

page[limit] — query

page[offset] — query

sort — query

filter — query

ResponseClear

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