List users

Retrieves a paginated list of all users in the current company.

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number for pagination (default: 1)
limitintegerNoNumber of items per page (default: 50)
orderstringNoField to sort by (default: id)
directionstringNoSort direction: asc or desc (default: desc)

Filtering

This endpoint supports advanced filtering. See the Filter System Documentation for the complete list of operators and usage examples.

Quick examples:

?filters[email][contains][email protected]
?filters[firstName][startsWith]=J
?filters[userGroup.name][eq]=Admin

Response Fields

FieldTypeDescription
idintegerUser unique identifier
emailstringUser email address
firstNamestringUser first name
lastNamestringUser last name
fullNamestringConcatenated first and last name
activebooleanWhether the account is active
invitePendingbooleantrue if the user has not yet accepted their invitation
companyobjectCompany the user belongs to
userGroupobjectUser group with inherited permissions
avatarstringAvatar image URL
phonestringPhone number
jobTitlestringJob title
languagestringPreferred locale (e.g. en, fr)
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp

Response

  • 200 OK: Returns paginated list of users
  • 401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Responses
200

Successful response

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!