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

# List invitations by email

> Fetch all invitations for a specific email address.



## OpenAPI

````yaml /api-reference/openapi-integrator.json get /v1/query/get-invitations-by-email
openapi: 3.0.3
info:
  title: Byzantine Integrator API
  description: Byzantine REST API for integrators.
  license:
    name: ''
  version: 0.2.0
servers:
  - url: https://sandbox.api.byzantine.fi
    description: Sandbox
security: []
tags:
  - name: API health
    description: Check API status.
  - name: Customer management
    description: Endpoints to create, update, and retrieve customer information.
  - name: Account management
    description: Endpoints to manage accounts, bank accounts, invitations, and user roles.
  - name: Products
    description: Endpoints to get data about products and vaults.
  - name: Transactions
    description: Endpoints to create and manage transactions.
  - name: OTP authentication
    description: Endpoints to initialize and manage user authentication with OTP.
  - name: Webhooks
    description: Integrator-managed outbound webhook subscriptions and delivery history.
paths:
  /v1/query/get-invitations-by-email:
    get:
      tags:
        - Account management
      summary: List invitations by email
      description: Fetch all invitations for a specific email address.
      operationId: get_invitations_by_email
      parameters:
        - name: X-Pubkey
          in: header
          description: >-
            Integrator's ECDSA public key (P-256 curve, compressed SEC1 format).
            Example:
            0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd
          required: true
          schema:
            type: string
        - name: X-Timestamp
          in: header
          description: >-
            Unix timestamp in seconds (UTC). Must be within tolerance window (1
            minute) to prevent replay attacks. Example: 1760375826
          required: true
          schema:
            type: string
        - name: X-Signature
          in: header
          description: >-
            ECDSA signature (DER-encoded, hex with 0x prefix). Signs the
            message: {timestamp}{METHOD}{path_and_query}{json_body}. Example:
            0x3045022100...
          required: true
          schema:
            type: string
        - name: email
          in: query
          description: The email to get invitations for
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Invitations retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInvitationsResponse'
        '400':
          description: Bad request - Invalid email
        '500':
          description: Internal server error
      security:
        - integrator_auth: []
components:
  schemas:
    GetInvitationsResponse:
      type: object
      required:
        - invitations
      properties:
        invitations:
          type: array
          items:
            $ref: '#/components/schemas/GetInvitationResponse'
          description: List of invitations with user details
    GetInvitationResponse:
      type: object
      required:
        - invitation_id
        - account_id
        - account_name
        - user_id
        - role
        - first_name
        - last_name
        - user_email
        - inviter_id
        - inviter_first_name
        - inviter_last_name
        - status
        - created_at
        - updated_at
      properties:
        invitation_id:
          $ref: '#/components/schemas/Uuid'
        account_id:
          $ref: '#/components/schemas/Uuid'
        account_name:
          type: string
        user_id:
          $ref: '#/components/schemas/Uuid'
        role:
          $ref: '#/components/schemas/AccountUserRole'
        first_name:
          type: string
        last_name:
          type: string
        user_email:
          type: string
        inviter_id:
          $ref: '#/components/schemas/Uuid'
        inviter_first_name:
          type: string
        inviter_last_name:
          type: string
        status:
          $ref: '#/components/schemas/InvitationStatus'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Uuid:
      type: string
      format: uuid
      description: A UUID string
      example: 550e8400-e29b-41d4-a716-446655440000
    AccountUserRole:
      type: string
      description: Role of a user in an account.
      enum:
        - root
        - admin
        - view
        - self_custodial
        - beneficiary
      example: root
    InvitationStatus:
      type: string
      description: Status of an invitation.
      enum:
        - pending
        - accepted
        - rejected
        - cancelled
      example: pending
  securitySchemes:
    integrator_auth:
      type: apiKey
      in: header
      name: X-Pubkey, X-Timestamp, X-Signature

````