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

# List pending team invitations

> Invitations that were sent with POST /organization/team and have not been accepted, cancelled or replaced yet, newest first. Expired invitations are not listed. An invited person appears in GET /organization/team only once they accept.

**Permissions:** requires **view** access to "Team & roles".

**Authentication:** send your organization API key in the `X-API-Key` header.

**Access:** read-only and full-access API keys. Dashboard members need view access to Team & roles.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/team/invitations
openapi: 3.0.0
info:
  title: Hyperprop Platform API
  version: 1.0.0
  description: >-
    REST API for the Hyperprop Trading Platform — provision evaluation and
    funded trading accounts, manage traders and plans, react to account
    lifecycle events via signed webhooks, and reconcile billing. Built for prop
    firms integrating from their own backend.


    Authentication, quick start, error handling, idempotency, pagination, custom
    metadata, webhooks, and the MCP connector are documented at
    https://docs.hyperprop.com.
  x-logo:
    url: https://app.hyperprop.com/logo-icon.svg
    altText: Hyperprop
    href: https://hyperprop.com
servers:
  - url: https://api.hyperprop.com/platform
    description: Production
security: []
tags:
  - name: Trading accounts
    description: Create, update, and inspect trading accounts.
  - name: Traders
    description: Look up and update the traders in your organization.
  - name: Trading plans
    description: Define the plans you sell.
  - name: Trading rules
    description: Define how accounts are evaluated.
  - name: Instruments
    description: >-
      The contracts your organization's accounts can trade, with their
      specifications.
  - name: Lockouts
    description: Pause and resume trading on an account.
  - name: Payouts
    description: Check payout eligibility and record payouts.
  - name: Purchases
    description: Purchases recorded for your organization.
  - name: Time Machine
    description: Restore accounts to an earlier trading day or instant.
  - name: Mass credit
    description: >-
      Credit back losses across many accounts after an incident, as background
      jobs you can follow, pause, export and reverse.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history, to replay or audit what happened.
  - name: Real-time streams
    description: >-
      Live events and trading data over a WebSocket, for dashboards and CRMs
      that update as things happen.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance, revenue and top traders.
  - name: Risk
    description: Firm profit and loss and plan economics.
  - name: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - name: Billing and invoices
    description: >-
      Your Hyperprop invoices, credits and billing details, with usage so far
      this month, billing cycles, forecasts and CSV exports.
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: >-
      Manage your organization's API keys: rotation, read-only keys and IP
      allowlists.
  - name: Logs and health
    description: >-
      API request logs, the audit log, integration health, and idempotency key
      recovery.
  - name: Organization profile
    description: Your organization's profile and logo.
  - name: Support
    description: Open and follow up on support tickets.
  - name: Partner access
    description: >-
      Read a trader's journal as an approved partner app, with the trader's own
      key.
paths:
  /v1/organization/team/invitations:
    get:
      tags:
        - Team and roles
      summary: List pending team invitations
      description: >-
        Invitations that were sent with POST /organization/team and have not
        been accepted, cancelled or replaced yet, newest first. Expired
        invitations are not listed. An invited person appears in GET
        /organization/team only once they accept.


        **Permissions:** requires **view** access to "Team & roles".


        **Authentication:** send your organization API key in the `X-API-Key`
        header.


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Team & roles.
      operationId: getV1OrganizationTeamInvitations
      responses:
        '200':
          description: Pending invitations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model779'
        '401':
          description: Missing, invalid or revoked API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 401
                  error:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Invalid or missing API key
                  code:
                    type: string
                    enum:
                      - UNAUTHORIZED
                    example: UNAUTHORIZED
                    description: >-
                      Machine-readable error code — switch on this, not on
                      message text
        '403':
          description: The API key may not make this request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 403
                  error:
                    type: string
                    example: Forbidden
                  message:
                    type: string
                    example: >-
                      Your role does not have view access to "Traders &
                      accounts"
                  code:
                    type: string
                    description: >-
                      `INSUFFICIENT_PERMISSIONS` = the role or key lacks the
                      permission this endpoint needs; `READ_ONLY_KEY` = a
                      read-only API key sent a request that changes data;
                      `IP_NOT_ALLOWED` = the request came from an address
                      outside the key's IP allowlist; `ORG_INACTIVE` = the
                      organization is not active
                    example: INSUFFICIENT_PERMISSIONS
                    enum:
                      - INSUFFICIENT_PERMISSIONS
                      - READ_ONLY_KEY
                      - IP_NOT_ALLOWED
                      - ORG_INACTIVE
        '500':
          description: An unexpected error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model10'
        '504':
          description: >-
            Gateway Timeout - The request did not complete within 25 seconds
            (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the
            request (for example a shorter date range).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model780'
      security:
        - X-API-Key: []
components:
  schemas:
    Model779:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model778'
    Model10:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: Internal Server Error
        message:
          type: string
          example: An unexpected error occurred
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INTERNAL_ERROR
    Model780:
      type: object
      properties:
        statusCode:
          type: number
          example: 504
        error:
          type: string
          example: Gateway Timeout
        message:
          type: string
          example: >-
            The request did not complete within 25 seconds. Try again, or narrow
            it (for example a shorter date range).
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: REQUEST_TIMEOUT
    Model778:
      type: object
      example:
        invitations:
          - id: 3b9d6c2e-8f41-4a7b-9c0d-2e5f6a7b8c9d
            email: sarah@example.com
            fullName: Sarah Johnson
            roleId: 7e0d1c9a-3f2b-4d5e-8a6f-1b2c3d4e5f60
            roleName: Support
            invitedAt: '2026-11-13T09:00:00.000Z'
            expiresAt: '2026-11-20T09:00:00.000Z'
      properties:
        invitations:
          $ref: '#/components/schemas/invitations'
    invitations:
      type: array
      items:
        $ref: '#/components/schemas/Model777'
    Model777:
      type: object
      properties:
        id:
          type: string
          description: >-
            Invitation ID, for DELETE
            /organization/team/invitations/{invitationId}
        email:
          type: string
          description: Invited email
        fullName:
          type: string
          description: Display name given when inviting
        roleId:
          type: string
          description: Role the person gets when they accept
        roleName:
          type: string
        invitedAt:
          type: string
        expiresAt:
          type: string
          description: The link stops working at this time
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key (`hp_live_...`), sent in the `X-API-Key` header.
        Create, rotate and restrict keys in the dashboard or with the API keys
        endpoints; an organization can have two active keys, so you can rotate
        without downtime. A **full-access** key can call every endpoint in this
        reference. A **read-only** key can call `GET` endpoints (and create a
        trading stream token); any other request returns `403 READ_ONLY_KEY`. A
        key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other
        address. Each endpoint lists which keys can call it under **Access**.

````

## Related topics

- [Team and roles](https://docs.hyperprop.com/guides/team-and-roles.md)
- [List organization audit events](https://docs.hyperprop.com/platform-api/logs-and-health/list-organization-audit-events.md)
- [List roles (system presets + your custom roles)](https://docs.hyperprop.com/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles.md)
- [List the accounts of a background run](https://docs.hyperprop.com/platform-api/time-machine/list-the-accounts-of-a-background-run.md)
- [Get all orders (filled, pending, cancelled)](https://docs.hyperprop.com/trade-api/orders/get-all-orders-filled-pending-cancelled.md)


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