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

# Read an account invitation

> Requires an active personal Firebase or MCP identity and the current canonical owner of the stored invitation scope. Scope comes from the stored invitation; caller cannot substitute a team or billing account. Configuration applies across live and test. approval_required reports missing proof metadata; a false value does not guarantee current approval validity. No token or acceptance URL is returned. Read delivery and revocation state separately from approval completion.



## OpenAPI

````yaml openapi.json GET /users/me/account-invitations/{id}
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /users/me/account-invitations/{id}:
    get:
      tags:
        - Account Approvals
      summary: Read an account invitation
      description: >-
        Requires an active personal Firebase or MCP identity and the current
        canonical owner of the stored invitation scope. Scope comes from the
        stored invitation; caller cannot substitute a team or billing account.
        Configuration applies across live and test. approval_required reports
        missing proof metadata; a false value does not guarantee current
        approval validity. No token or acceptance URL is returned. Read delivery
        and revocation state separately from approval completion.
      operationId: getAccountInvitation
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9_-]{1,128}$
        - $ref: '#/components/parameters/TeamParameter'
      responses:
        '200':
          description: >-
            Safe invitation metadata only; no invitation token or acceptance
            URL.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/AccountInvitation'
                  timestamp:
                    type: integer
              example:
                success: true
                data:
                  id: inv_example
                  email: member@example.com
                  role: admin
                  team_id: team_example
                  type: team
                  billing_account_id: billing_example
                  approval_required: false
                  status: pending
                  created_at: 1700000000000
                  expires_at: 1700604800000
                  created_by: user_owner
                  delivery:
                    status: not_requested
                    attempted_at: null
                timestamp: 1700000000000
        '400':
          description: Invalid invitation ID or body.
        '401':
          description: Active personal identity required.
        '403':
          description: Current canonical scope owner or completed approval required.
        '404':
          description: Invitation or scope not found.
        '409':
          description: >-
            Invitation is no longer pending, delivery_in_progress, or
            delivery_outcome_unknown. Inspect current state before taking
            another action.
        '500':
          description: >-
            Outcome is not established. Read invitation state; do not
            automatically repeat a resend.
      security:
        - bearerAuth: []
components:
  parameters:
    TeamParameter:
      name: team
      in: query
      required: false
      schema:
        type: string
      description: >
        **gigstack Connect:** Target team ID for multi-team access.


        Requires gigstack Connect enabled on your team and shared billing
        account.


        Also requires the `multipleIssuerAccounts` feature on your plan.
        Requests targeting a

        team other than the one your API key belongs to return `403` without it.


        Only API keys can use it: an OAuth access token sent with another team's
        id is rejected with

        `403 Team mismatch with OAuth token`.


        **Optional — omit it entirely** unless you are acting on another team.
        It deliberately

        carries no example value so generated snippets do not emit
        `?team=undefined`; when the

        parameter is absent, the team is derived from your API key.


        **Example:** `?team=team_xyz789`
  schemas:
    AccountInvitation:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
        email:
          type: string
        role:
          type: string
          enum:
            - admin
            - editor
            - viewer
        team_id:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - team
            - billingAccount
        billing_account_id:
          type: string
          nullable: true
        approval_required:
          type: boolean
        status:
          type: string
          enum:
            - pending
            - accepted
            - declined
            - revoked
            - expired
        created_at:
          type: number
          nullable: true
        expires_at:
          type: number
          nullable: true
        created_by:
          type: string
          nullable: true
        delivery:
          type: object
          additionalProperties: false
          properties:
            status:
              type: string
              enum:
                - not_requested
                - pending
                - sent
                - failed
                - unknown
            attempted_at:
              type: number
              nullable: true
          required:
            - status
            - attempted_at
      required:
        - id
        - email
        - role
        - team_id
        - type
        - billing_account_id
        - approval_required
        - status
        - created_at
        - expires_at
        - created_by
        - delivery
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.