> ## 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 Invites

> Get all invites for an event with optional status filtering

This endpoint lets you retrieve all the invitations you've sent for a specific event, with options to filter by status.

**What it does:**

* Retrieves all invitations for a particular event
* Allows filtering by invitation status (pending, sent, accepted, rejected)
* Provides complete information about each invite and its current status

**When to use it:**

* To monitor invitation response rates
* When following up with people who haven't responded
* To generate guest lists for accepted invitations
* For reporting on invitation metrics

## Path Parameters

| Parameter  | Type   | Required | Description                        |
| ---------- | ------ | -------- | ---------------------------------- |
| `event_id` | string | Yes      | The unique identifier of the event |

## Query Parameters

| Parameter | Type   | Required | Description                                                                          |
| --------- | ------ | -------- | ------------------------------------------------------------------------------------ |
| `status`  | string | No       | Filter invites by status. Options include: "pending", "sent", "accepted", "rejected" |

## Response

The API returns an array of invite objects matching the specified criteria:

```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"
  },
  {
    "id": "invite-124",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane.smith@example.com",
    "country_code": "1",
    "mobile_number": "5559876543",
    "authentication_method": "Biometric",
    "event_id": "event-456",
    "session_code": "DEF456",
    "session_id": "session-790",
    "image": "https://example.com/profile-photos/jane-smith.jpg",
    "status": "pending",
    "created_at": "2023-02-28T12:01:00Z",
    "updated_at": "2023-02-28T12:01:00Z",
    "last_seen": null
  }
]
```

**Invite status meanings:**

* `pending`: Invitation has been created but not sent yet
* `sent`: Invitation has been sent but no response yet
* `accepted`: Invitee has accepted the invitation
* `rejected`: Invitee has declined the invitation

**Tip:** To get only accepted invitations (for creating a guest list), include `?status=accepted` in your query.


## OpenAPI

````yaml GET /events/{event_id}/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:
  /events/{event_id}/invites:
    get:
      summary: Get Invites
      description: Get all invites for an event with optional status filtering
      operationId: get_invites_events__event_id__invites_get
      parameters:
        - name: event_id
          in: path
          required: true
          schema:
            type: string
            title: Event Id
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/InviteStatus'
              - type: 'null'
            title: Status
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Invite'
                title: Response Get Invites Events  Event Id  Invites Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    InviteStatus:
      type: string
      enum:
        - pending
        - sent
        - accepted
        - rejected
      title: InviteStatus
    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
    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.

````