Accounts

Search for accounts

List accounts. Results are paginated.

get/v1/accounts

Request

  • Base URL
    https://api.capacity.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-capacity-id
    • or HTTP bearer

Query parameters

pageinteger

Result page number

limitinteger

Number of results per page

namestring

search for accounts by name

Response

An array of Account objects

bodyobject

Json body data in the request

limitinteger

Number of results returned

pageinteger

Page of results returned

parametersobject

Query parameters in the request

Example response

{
  "result": [
    {
      "renewal_date": "2023-01-01 00:00:00",
      "parent_account": {
        "renewal_date": "2023-01-01 00:00:00"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.