v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Users

List all users

Returns users in your Dotfile workspace. By default, only active users are returned. If you need suspended users, you can set the include_suspended query parameter to "true".


See also

Learn more about Filtering, Sorting and Pagination

get/v1/users

Query parameters

include_suspendedboolean

Whether suspended users should be included or not in the response

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.

Response

List of users in the workspace

ℹ️ Click to see full payload

Example response

{
  "pagination": {
    "count": 42
  }
}