Skip to main content
GET
/
admin
/
users
List accountant users
curl --request GET \
  --url https://api.steuerboard.com/v1/admin/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cmf41ajzv003706un4i99q1b1",
      "createdAt": "2024-08-20T12:34:56Z",
      "email": "[email protected]",
      "firstName": "Alex",
      "lastName": "Müller",
      "roles": [
        {
          "id": "cmf41ajzv003706un4i99q1a0",
          "name": "accountant_admin",
          "customName": "Head of Accounting"
        }
      ]
    }
  ],
  "pagination": {
    "limit": 20,
    "total": 134,
    "nextCursor": "cmf41ajzv003706un4i99q19z",
    "previousCursor": "cmf41ajzv003706un4i99q19z"
  }
}
This endpoint only works with the Accountant API key. More information here

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Query Parameters

​
limit
number
default:20

The number of items to return

Required range: 1 <= x <= 100
Example:

20

​
cursor
string<cuid>

The cursor to return the next page of items

Example:

"cmf41ajzv003706un4i99q19z"

​
sort
enum<string>
default:createdAt

The sort field of the results

Available options:
createdAt,
updatedAt,
email,
firstName,
lastName
​
order
enum<string>
default:desc

The order of the results based on the sort field

Available options:
asc,
desc

Response

Accountant users

​
data
object[]
required
​
pagination
object
required