Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
User management

List users

This API returns a paginated list of Dashboard members in your organization. Use this endpoint to review existing users, filter by manager status, or sort results by ID or email.

get/v1/users

Query parameters

offsetinteger

The number of records to skip before returning results. Used for pagination. Defaults to 0 if not specified.

limitinteger
Example:50

The maximum number of records to return per page, starting from the specified offset value. Defaults to 50 if not specified.

is_managerboolean
Example:true

Use this parameter to narrow results by manager status. Set to true to return only users with manager permissions, or false to return only standard users. If not provided, all users in your organization are returned regardless of their manager status.

sort'id' | 'email'
Example:id

The field to use when sorting the list of users. Use id to sort by the user's unique identifier, or email to sort alphabetically by email address. Defaults to id if not specified.

order'asc' | 'desc'
Example:asc

The sort direction for the results. Use asc for ascending order or desc for descending order. Defaults to asc if not specified.

Response

Users retrieved successfully

totalinteger

Total number of users in the organization matching the query.

offsetinteger

The number of records skipped for this page. Reflects the offset value submitted in the request.

limitinteger

The maximum number of records returned for this page. Reflects the limit value submitted in the request.

Example response

{
  "users": [
    {
      "id": 1042,
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe"
    }
  ],
  "total": 2,
  "limit": 50
}