Get All Accounts

GET 
/v2/accounts

Use this endpoint to Get all accounts.

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

Filtering

The following operators and attributes are available for filtering accounts:

Attribute	Type	Operators	Example
name	string	eq like	like(name,*swan*)
legal_name	string	eq like	like(legal_name,*swan*)
registration_id	string	eq like	like(registration_id,00000000-0000-1000-8000-*)
external_ref	string	eq like	like(external_ref,16be*)
id	string	eq ge gt le lt in	in(id,"99248259-feea-40c6-b855-f719ee87a539", "363e4505-a2bb-4bc1-b667-2cc9a4de8668")
created_at	string	eq ge gt le lt	gt(created_at,"2021-06-02T18:44:07.617Z")
updated_at	string	eq ge gt le lt	ge(updated_at,"2021-06-07T18:24:48.149Z")

Request

Query Parameters

filter string

Specifies the filter attributes.

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.

Responses

200

OK

application/json

Schema

Schema

data object[]
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": [
    {
      "type": "account",
      "name": "acc-name",
      "legal_name": "acc-legal-name",
      "registration_id": "reg-id",
      "external_ref": "ext-ref",
      "id": "deb6b25f-8451-4211-9a22-95610333df23",
      "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/accounts/deb6b25f-8451-4211-9a22-95610333df23"
      }
    }
  ],
  "meta": {
    "page": {
      "limit": 25,
      "current": 0,
      "offset": 0,
      "total": 1
    },
    "results": {
      "total": 1
    }
  },
  "links": {
    "current": "https://useast.api.elasticpath.com/v2/accounts?page[offset]=0&page[limit]=25",
    "first": "https://useast.api.elasticpath.com/v2/accounts?page[offset]=0&page[limit]=25",
    "last": "https://useast.api.elasticpath.com/v2/accounts?page[offset]=0&page[limit]=25",
    "next": null,
    "prev": null
  }
}

401

Unauthorized

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

unauthorized-error

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

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...