DOdovetail
Users

List users

Changed on

Retrieve all members of your workspace. Returns each user's profile information including name, email, job title, role, and admin status.

Results can be filtered by name or email and sorted by creation date or name. They are paginated.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Required scope: user:read

get/v1/users

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/users
  • Auth
    HTTP bearer

Query parameters

start_cursorstring
limitinteger nullable

See Pagination for details about how to use a cursor to iterate through the list.

Filter results based on user name or email.

'created_at:asc' | 'created_at:desc' | 'name:asc' | 'name:desc'
OR
string[]

See Sort for details on the sort parameter.

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status