Get paginated users list in a segment
Authentication
X-Api-Keystring
API Key authentication via header
Path parameters
segment_id
Headers
X-Workspace-Id
Query parameters
search_key
page
Page number. The maximum bounds deep-offset scans only; it is deliberately high because maximum * per_page is the total number of reachable users, and a low cap silently hides users in large tenants. Result-set size is bounded by per_page, not by this.
per_page
sort_order
is_deleted
Filter by deactivation state. true returns only deactivated users, false returns only active users. When omitted, active users are returned by default unless include_deactivated is set. Do not add a schema default here: a materialised default makes the param non-null and renders include_deactivated unreachable in the controller.
role
type
Automation entity type (see allowed values in the enum schema).
Allowed values:
include_deactivated
Response
Successful response
