List Team Users

Retrieve platform users and pending invitations for your company.

GET
/api/v1/team-users?page=1&activeinvite=0

Description

Returns a paginated list of team users or invitations. Use activeinvite=1 to list registered active users; omit or use 0 for pending invitations.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number. Default is 1.
limitnumberNoRecords per page. Default is 10 (tickets/wallet max 100).
activeinvitenumberNo1 = active registered users; 0 or omitted = invitations.
statusnumberNoInvite status filter (-1 for all).
countrystringNoFilter by country code.
keywordstringNoSearch by name or email.
filter_by_rolenumberNoCorporate role: 1=Department head, 2=Manager, 3=Requester.

Response

Notes

  • With activeinvite=1 the response uses users[] instead of invitations[] and is_invitations_flag is false.

Related Endpoints

Did this page help you?