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

# List pending invitations

> Lists the team's invitations that haven't been accepted yet. Needs the `team.operate` or `team.manage` permission.



## OpenAPI

````yaml /spec/platform-teams.yaml get /v2/teams/{teamID}/invitations
openapi: 3.0.1
info:
  title: Teams & Access
  version: 1.0.0
  description: >
    Create teams, invite people, and control what each member can do.


    A team is a separate account that owns its own resources and billing.

    Members work on the team's resources with their own API token by adding

    `teamID` to their requests. Access comes from two places:


    - **Role permissions** apply across the whole team. Every member has
      exactly one role.
    - **Resource permissions** give one member access to one specific
      resource, such as a single app or database.

    A request is allowed if either source grants a required permission.


    Every team starts with these built-in roles:


    | Role | Permissions |

    |------|-------------|

    | مالک | `manage` and `create` on every resource type, plus `billing.manage`
    and `team.manage`. The team creator always has this role. |

    | مدیر | `manage` and `create` on every resource type |

    | گرداننده | `operate` on every resource type |

    | بازرس | `view` on every resource type |

    | حسابدار | `billing.manage` |

    | مهمان | No permissions |


    The number of members, custom roles and resource permissions per team,

    and the number of teams per user, are limited.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Teams
    description: Create, list, rename and delete teams.
  - name: Invitations
    description: Invite people to a team and accept invitations.
  - name: Members
    description: List members, remove them, change their role, or leave a team.
  - name: Roles
    description: List roles and manage custom roles.
  - name: Resource Permissions
    description: Give members access to specific resources.
paths:
  /v2/teams/{teamID}/invitations:
    get:
      tags:
        - Invitations
      summary: List pending invitations
      description: >-
        Lists the team's invitations that haven't been accepted yet. Needs the
        `team.operate` or `team.manage` permission.
      operationId: listInvitations
      parameters:
        - $ref: '#/components/parameters/TeamIDPath'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Count'
      responses:
        '200':
          description: Pending invitations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalInvitations:
                    type: integer
                  invitations:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invitation'
              example:
                totalInvitations: 1
                invitations:
                  - _id: '000000000000000000000030'
                    team: '000000000000000000000002'
                    email: teammate@example.com
                    role:
                      name: گرداننده
                    status: pending
                    createdAt: '2026-01-01T08:00:00.000Z'
                    updatedAt: '2026-01-01T08:00:00.000Z'
        '400':
          $ref: '#/components/responses/InvalidTeamIDOrParams'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TeamForbidden'
components:
  parameters:
    TeamIDPath:
      name: teamID
      in: path
      required: true
      description: The team's ID.
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000002'
    Page:
      name: page
      in: query
      required: false
      description: Page number, starting at 1.
      schema:
        type: integer
        minimum: 1
        default: 1
    Count:
      name: count
      in: query
      required: false
      description: Items per page.
      schema:
        type: integer
        minimum: 1
        default: 10
  schemas:
    Invitation:
      type: object
      properties:
        _id:
          type: string
          description: Invitation ID. Use it as `invitationID`.
        team:
          type: string
        email:
          type: string
          format: email
        role:
          type: object
          properties:
            name:
              type: string
        status:
          type: string
          enum:
            - pending
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ObjectID:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: 24-character hexadecimal ID.
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    InvalidTeamIDOrParams:
      description: '`teamID`, another ID or a query parameter is invalid.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 400
            error: Bad Request
            message: Invalid team ID.
            data: null
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
    TeamForbidden:
      description: >-
        You aren't a member of this team (`team_not_found`), or your role
        doesn't have the required permission (`no_permission`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            teamNotFound:
              summary: Not a team member
              value:
                statusCode: 403
                error: Forbidden
                message: Team not found
                data:
                  code: team_not_found
            noPermission:
              summary: Missing permission
              value:
                statusCode: 403
                error: Forbidden
                message: You do not have permission to access this resource.
                data:
                  code: no_permission
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

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