Batch Lookup Users

List users with optional filtering by IDs, with pagination.

If user_ids are provided, filters to only those users. Otherwise returns all accessible users. Results are filtered by group permissions - users must share at least one group with READER+ access.

Super users can see all users.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query Parameters

sort_bystring or nullOptional
sort_orderstringOptionalformat: "^(asc|desc)$"Defaults to asc
pageintegerOptional>=1Defaults to 1
page_sizeintegerOptional>=1Defaults to 100

Request

This endpoint expects an object.
user_idslist of integers or nullOptional
Optional list of user IDs to filter by. If not provided, returns all accessible users.
pageintegerOptional>=1Defaults to 1
Page number
page_sizeintegerOptional1-1000Defaults to 100
Number of items per page
sort_bystring or nullOptional
Field to sort by
sort_orderstringOptionalDefaults to asc

Sort order: ‘asc’ or ‘desc’

Response

Successful Response
total_countinteger
pageinteger
page_sizeinteger
datalist of objects

Errors