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

# Get Invite By Email

> Get invite details for a single person by email address

This endpoint looks up an invitation using an email address. It's particularly useful when attendees need to find their own invitation or when you're searching for someone by email rather than invite ID.

**What it does:**

* Finds an invitation using an email address instead of an ID
* Can search within a specific event or across all events
* Returns complete details about the matching invitation

**When to use it:**

* When an attendee contacts you saying they lost their invitation
* For customer support when helping attendees
* When building a "look up your invitation" feature on your website
* When searching for a specific person but you only have their email

## Query Parameters

| Parameter  | Type   | Required | Description                                                |
| ---------- | ------ | -------- | ---------------------------------------------------------- |
| `email`    | string | Yes      | The email address of the invitee                           |
| `event_id` | string | No       | The unique identifier of a specific event to search within |

## Response

The API returns the invite object that matches the specified email address:

```json theme={null}
{
  "id": "invite-123",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "country_code": "1",
  "mobile_number": "5551234567",
  "authentication_method": "QR Code",
  "event_id": "event-456",
  "session_code": "ABC123",
  "session_id": "session-789",
  "image": "https://example.com/profile-photos/john-doe.jpg",
  "status": "accepted",
  "created_at": "2023-02-28T12:00:00Z",
  "updated_at": "2023-03-01T09:30:00Z",
  "last_seen": "2023-03-01T10:15:00Z",
  "onyxplus_id": "onyx-123",
  "ticket_id": "ticket-456"
}
```

**Tip:** If you don't provide an `event_id` parameter, the API will search for the email across all events. This can be useful, but if you know which event you're looking for, adding the `event_id` will make the search faster and more specific.


## OpenAPI

````yaml GET /invites
openapi: 3.1.0
info:
  title: Securegate.ai API
  version: 0.1.0
servers:
  - url: https://api.securegate.ai
    description: Production environment
security:
  - ApiKeyAuth: []
paths:
  /invites:
    get:
      summary: Get Invite By Email
      description: Get invite details for a single person by email address
      operationId: get_invite_by_email_invites_get
      parameters:
        - name: email
          in: query
          required: true
          schema:
            type: string
            title: Email
        - name: event_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Event Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invite'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Invite:
      properties:
        first_name:
          type: string
          title: First Name
        last_name:
          type: string
          title: Last Name
        email:
          type: string
          title: Email
        country_code:
          $ref: '#/components/schemas/CountryCodeSimple'
        mobile_number:
          type: string
          title: Mobile Number
        authentication_method:
          $ref: '#/components/schemas/AuthenticationMethod'
        id:
          type: string
          title: Id
        event_id:
          type: string
          title: Event Id
        session_code:
          type: string
          title: Session Code
        image:
          anyOf:
            - type: string
            - type: 'null'
          title: Image
        session_id:
          type: string
          title: Session Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        last_seen:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Seen
        onyxplus_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Onyxplus Id
        ticket_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Ticket Id
        status:
          $ref: '#/components/schemas/InviteStatus'
          default: pending
      type: object
      required:
        - first_name
        - last_name
        - email
        - country_code
        - mobile_number
        - authentication_method
        - id
        - event_id
        - session_code
        - session_id
        - created_at
        - updated_at
      title: Invite
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CountryCodeSimple:
      type: string
      enum:
        - '1'
        - '44'
        - '1'
        - '61'
        - '91'
        - '345'
      title: CountryCodeSimple
    AuthenticationMethod:
      type: string
      enum:
        - QR Code
        - Biometric
        - Both
      title: AuthenticationMethod
    InviteStatus:
      type: string
      enum:
        - pending
        - sent
        - accepted
        - rejected
      title: InviteStatus
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key authentication. Add your API key as the value of the 'x-api-key'
        header.

````