Skip to main content
Search Users

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

team_id
integer<int64>
required

Team ID to search within

Required range: x >= 0

Query Parameters

username
string

Optional filter by username (partial match supported)

status
enum<string>

Optional filter by user status (e.g., 'active', 'inactive')

Available options:
USER_STATUS_UNSPECIFIED,
USER_STATUS_ACTIVE,
USER_STATUS_INACTIVE
page_size
integer<int64>

Number of results per page

Required range: x >= 0
page_token
integer<int64>

Token for pagination to retrieve the next page of results

Required range: x >= 0

Response

Response containing a paginated list of users matching the search criteria, along with pagination tokens and total count.

nextPageToken
integer<int64>

Token for the next page of results. Empty if no more pages available.

Required range: x >= 0
totalCount
integer<int64>

Total number of users matching the search criteria across all pages

Required range: x >= 0
users
User · object[]

List of users matching the search criteria