v1

latestOpenAPI 3.0.22026-07-261040577.4 KB
Users

List users

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.

get/v1/users

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