List users by email

Look up a user by email address when the internal user ID is not known. Since email is unique, the response contains at most 1 item. Returns an empty array when no match is found.

🔒 External clients call this endpoint with an OAC (Organisation Access Credentials — ⚠️ Beta) access token carrying the users:read scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Email address of the user to look up

string
enum

Related resource to include in the response

Allowed:
Headers
string
required

Signature is used to enforce security by signing request.
Related documentation can be found by clicking here

string
required

RFC2822 formatted date.

string
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

uuid v4. Required in Redirect mode.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Choose an example:
application/json