> ## Documentation Index
> Fetch the complete documentation index at: https://docs.timbrix.mx/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User by Email

> ⚠️ SECURITY: Retrieves user profile by email address. Requires authentication with scope "read:user". Supports both OAuth tokens and API keys. Useful for user lookups and invitations.

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

| Parameter | Type   | Required | Description        |
| --------- | ------ | -------- | ------------------ |
| `email`   | string | Yes      | User email address |

## Authentication

Supports both:

* **OAuth tokens**: `Authorization: Bearer <oauth_token>`
* **API keys**: `X-API-Key: sk_...`

## Example Request

```bash theme={null}
curl -X GET http://localhost:3001/api/users/email/user@example.com \
  -H "Authorization: Bearer <token>"
```

## Example Response

```json theme={null}
{
  "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.


## OpenAPI

````yaml GET /users/email/{email}
openapi: 3.1.0
info:
  title: Timbrix API
  description: >-
    REST API with OAuth2 server for managing organizations, members, and
    webhooks
  version: '1.0'
  contact: {}
servers:
  - url: http://sandbox.mintlify.com
    description: Sandbox environment
  - url: http://localhost:3001/api
    description: Local development
security: []
tags:
  - name: organizations
    description: Organization management endpoints
  - name: oauth
    description: OAuth2 authentication and authorization
  - name: webhooks
    description: Webhook configuration and delivery
  - name: users
    description: User information endpoints
  - name: api-keys
    description: API Keys management and validation
paths:
  /users/email/{email}:
    get:
      tags:
        - users
      summary: Get user by email
      description: >-
        ⚠️ SECURITY: Retrieves user profile by email address. Requires
        authentication with scope "read:user". Supports both OAuth tokens and
        API keys. Useful for user lookups and invitations.
      operationId: UsersController_getByEmail
      parameters:
        - name: email
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: User retrieved successfully. Returns user profile information.
        '401':
          description: Authentication required. Provide a valid OAuth token.
        '403':
          description: 'Insufficient scope. Required scope: read:user'
        '404':
          description: User not found with the provided email address.
      security:
        - apiKey: []
        - bearer: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API Key for authentication (format: sk_...)'
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````