Skip to main content
GET
/
users
/
email
/
{email}
Get user by email
curl --request GET \
  --url http://sandbox.mintlify.com/users/email/{email} \
  --header 'X-API-Key: <api-key>'
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

ParameterTypeRequiredDescription
emailstringYesUser email address

​
Authentication

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

​
Example Request

curl -X GET http://localhost:3001/api/users/email/user@example.com \
  -H "Authorization: Bearer <token>"

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "user@example.com",
  "name": "John Doe",
  "createdAt": "2025-01-01T00:00:00Z"
}

​
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.