Get a List of Unassigned Account Members
GEThttps://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/unassigned-account-members
Use this resource to get a list of all account members that are not assigned to an account.
Filtering
The following operators and attributes are available for filtering unassigned account members.
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. |
The following attributes are available for filtering unassigned account members.
Attribute | Type | Operator | Example |
---|---|---|---|
email | string | eq / like | eq(email,ronswanson@example.com) |
name | string | eq / like | like(name,*swan*) |
You can use pagination with this resource. For more information, see pagination.
Request
Path Parameters
The ID of the account for which you want to get the list of unassigned account members.
Query Parameters
The number of records per page.
Possible values: <= 10000
The number of records to offset the results by.
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.
Specifies the filter attributes.
Responses
- 200
- 404
- 409
- default
OK
- application/json
- Schema
- Example (auto)
Schema
meta object
links object
{
"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/accounts/deb6b25f-8451-4211-9a22-95610333df23/account-memberships/unassigned-account-members?page[offset]=0&page[limit]=25",
"first": "https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/account-memberships/unassigned-account-members?page[offset]=0&page[limit]=25",
"last": "https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/account-memberships/unassigned-account-members?page[offset]=0&page[limit]=25",
"next": null,
"prev": null
}
}
Not Found
- application/json
- Schema
- Example (auto)
- not-found-error
Schema
errors object[]required
{
"errors": [
{
"title": "string",
"status": "string",
"detail": "string"
}
]
}
{
"errors": [
{
"title": "Not Found",
"status": "404",
"detail": "account not found"
}
]
}
Conflict
- application/json
- Schema
- Example (auto)
- conflict-error
Schema
errors object[]required
{
"errors": [
{
"title": "string",
"status": "string",
"detail": "string"
}
]
}
{
"errors": [
{
"title": "Conflict",
"status": "409",
"detail": "account membership with the given account id and account member id already exists"
}
]
}
Internal server error.
- application/json
- Schema
- Example (auto)
- internal-server-error
Schema
errors object[]required
{
"errors": [
{
"title": "string",
"status": "string",
"detail": "string"
}
]
}
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/unassigned-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());