v1

latestOpenAPI 3.1.12026-07-124448163.2 KB
admin.users

List accountant users

Returns a paginated list of accountant users.

get/admin/users

Query parameters

limitnumber

The number of items to return

Example:20
cursorstring cuid

The cursor to return the next page of items

Example:cmf41ajzv003706un4i99q19z
sort'createdAt' | 'updatedAt' | 'email' | 'firstName' | 'lastName'

The sort field of the results

order'asc' | 'desc'

The order of the results based on the sort field

Response

Accountant users

Example response

{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q1b1",
      "createdAt": "2024-08-20T12:34:56Z",
      "email": "alex@example.com",
      "firstName": "Alex",
      "lastName": "Müller",
      "roles": [
        {
          "id": "cmf41ajzv003706un4i99q1a0",
          "name": "accountant_admin",
          "customName": "Head of Accounting"
        }
      ]
    }
  ],
  "pagination": {
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z",
    "limit": 20,
    "total": 134
  }
}