Search people in a workspace

Beta
Prefix-search the people an asset in this workspace can be shared with — active members plus external viewers provisioned for the workspace — by email, first name or last name. Built for share pickers: a query of at least two characters is required, results are capped, and only name and email are returned (no user ids). Callers must be a member of the workspace (or a deployment admin). External SSO viewers may search only their own workspace, only see people in their own email domain, receive at most 10 results per call, and hold a per-viewer budget of 120 searches per 10 minutes (429 with Retry-After when exhausted; 503 if the budget cannot be enforced).

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

workspace_idstringRequired
Unique identifier of the workspace to search

Query parameters

qstringRequired2-100 characters

Search prefix, matched case-insensitively against email, first name and last name

limitintegerOptional1-50Defaults to 20
Maximum number of people to return

Response

Matching people, ordered by email
memberslist of objects
People matching the prefix, ordered by email
querystring
The normalized search prefix that was applied
workspace_idstring
The workspace that was searched

Errors

403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error