UserResourceSearch

Search for a single user

Search by email and/or SCIM external ID. The caller may only access users that share team or organization membership, or that are provisioned in the organization.

Required API key permissions

  • Scope: users:get
  • 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.
  • Root organization access: API keys bound to a sub-organization may also read users provisioned in the root organization.
  • Notes: Root organization user reads apply to the email search only; the SCIM external ID search stays within the caller's own organizations.
get/api/public/v1/user/search

Request

Query parameters

Emailstring
ScimExternalIdstring

Response

OK

idstring uuid
emailstring nullable
userNamestring nullable
displayNamestring nullable
phoneNumberstring nullable
timeZoneIdstring nullable
disableWeeklyIncidentEngagementReportboolean

Changes

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