Accounts

List accounts

GET /api/v1/accounts

List accounts

Returns accounts that can be targeted when creating or managing agents. Parent accounts receive themselves and their active direct clients; child accounts receive only themselves.

Parameters

Name	In	Type	Description
`query`	query	string	Search by account name or external account id.
`cursor`	query	string	Opaque cursor returned by the previous page.
`limit`	query	integer	Maximum number of accounts to return.
`sort`	query	string	Account field used to sort results.
`order`	query	string	Sort direction.

Responses

Status	Schema	Description
`200`	AccountList	Accessible accounts
`400`	Error	Invalid query params
`401`	Error	Missing or invalid auth
`403`	Error	Missing agents:read scope

Example 200 response

{
    "data": [
        {
            "id": 1,
            "externalId": "string",
            "name": "string",
            "parentId": 1
        }
    ],
    "pageInfo": {
        "hasNextPage": true,
        "endCursor": "string"
    }
}

Example 400 response

{
    "error": "string",
    "message": "string"
}

Example 401 response

{
    "error": "string",
    "message": "string"
}

Example 403 response

{
    "error": "string",
    "message": "string"
}