UserResourceSearch

Search for users in your organization

Only users provisioned in your organization are returned (created via Terraform, Public API, or SCIM). You cannot list users that are only associated by membership. For a single user reachable by membership only, use GET api/public/v1/user/search without the /list suffix. Supports paging (default limit 100, max 100).

Required API key permissions

  • Scope: users:list
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Access is limited to the teams and organizations visible to the API key.
  • Notes: Only users provisioned in organizations visible to the caller are returned. Unlike the single-user search, this list never includes users provisioned in the root organization when the key is bound to a sub-organization.
get/api/public/v1/user/search/list

Request

Query parameters

Emailstring
DisplayNamestring
Offsetinteger
Limitinteger

Response

OK

hasMoreboolean

Changes

No recorded changes to this operation across all 1 revision of this API.