Alpha APIKnowledge

Find Person

View as Markdown
Look someone up in this vault's people registry: name, e-mail, title, organisation. The ONLY authoritative source for an address. never guess one or assume a pattern like first.last@company.com.

Authentication

AuthorizationBearer
Create a personal key in Alpha settings, or use an access token issued to an approved OAuth client.

Request

This endpoint expects an object.
vaultstringOptional

Exact vault id or name from list_vaults. Required whenever the key can reach more than one vault; never guess or use one client’s vault for another.

querystringOptional
Name, address or role fragment

Response headers

X-Request-IdstringOptional
Stable identifier for tracing this request in Alpha logs.

Response

Find Person completed.
datamap from strings to any or list of maps from strings to any
The result returned by the selected Alpha tool.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error