Skip to main content
GET /v1/accounts

[{
  "id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "role": "administrator",
  "active": true,
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "organisation_id": "62e9a87c6ed1444d9d228c4a0374017d",
  "created": "2019-12-17T05:30:00Z",
  "verified": "2019-12-17T05:30:00Z"
}]
Returns a list of accounts associated with your organisation. Results are returned in descending order of creation date, with the most recently created accounts appearing first. Use this endpoint to manage your organisation’s team structure, audit user accounts, or retrieve subsets of accounts based on role, group membership, or other attributes. Results can be narrowed using exact-match filters. The response is limited to a maximum of 1,000 results.

​
Partner-specific behavior

If you’re part of the Partner Program and supply a valid X-Annature-Partner header, this endpoint will return all accounts provisioned by your integration — across every organisation you’ve registered using the Register an account endpoint. It excludes your own internal users. If the X-Annature-Partner header is not provided, the endpoint returns only the accounts within your own organisation.

​
Parameters

​
name
string
Filter results by exact match on the account’s name property.
​
email
string
Filter results by exact match on the account’s email property.
​
role
string
Filter results by exact match on the account’s role. Valid values include: administrator, standard, read-only.
​
active
string
Filter results by exact match on the account’s active status. Accepts true or false.
​
group_id
string
Filter results by exact match on the group_id to list accounts within a specific account group.
​
created_before
string
Return accounts created before the specified ISO 8601 timestamp.
​
created_after
string
Return accounts created after the specified ISO 8601 timestamp.
GET /v1/accounts

[{
  "id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "name": "Ted Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "timezone": "+10:00",
  "role": "administrator",
  "active": true,
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "organisation_id": "62e9a87c6ed1444d9d228c4a0374017d",
  "created": "2019-12-17T05:30:00Z",
  "verified": "2019-12-17T05:30:00Z"
}]