Skip to main content
GET
Get user by email
Retrieves user profile by email address. Requires authentication with scope read:user. Supports both OAuth tokens and API keys.

Permissions

Requires authentication with scope read:user.

Path Parameters

Authentication

Supports both:
  • OAuth tokens: Authorization: Bearer <oauth_token>
  • API keys: X-API-Key: sk_...

Example Request

Example Response

Use Cases

  • User lookups for invitations
  • Email verification
  • User profile retrieval
  • Integration with external systems

Common Errors

401 Unauthorized

Authentication required. Provide a valid OAuth token.

403 Forbidden

Insufficient scope. Required scope: read:user

404 Not Found

User not found with the provided email address.

Authorizations

X-API-Key
string
header
required

API Key for authentication (format: sk_...)

Path Parameters

email
string
required

Response

User retrieved successfully. Returns user profile information.