> ## 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 your teams

> Lists the teams you're a member of.



## OpenAPI

````yaml /spec/platform-teams.yaml get /v2/teams
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:
    get:
      tags:
        - Teams
      summary: List your teams
      description: Lists the teams you're a member of.
      operationId: listTeams
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Count'
      responses:
        '200':
          description: Your teams.
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalTeams:
                    type: integer
                    description: Total number of teams you're a member of.
                  teams:
                    type: array
                    items:
                      $ref: '#/components/schemas/TeamSummary'
              example:
                totalTeams: 1
                teams:
                  - _id: '000000000000000000000002'
                    name: my-team
                    color: CARBON_SEA
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    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:
    TeamSummary:
      type: object
      properties:
        _id:
          type: string
          description: The team's ID. Pass it as `teamID`.
        name:
          type: string
        color:
          $ref: '#/components/schemas/TeamColor'
    TeamColor:
      type: string
      enum:
        - PURPLE_FIRE
        - GOLDEN_NATURE
        - WOLF_AND_MIST
        - CARBON_SEA
        - WINTER_FOG
        - RED_SEA
    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:
    ValidationError:
      description: The request is invalid. `message` says which field failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 400
            error: Bad Request
            message: '"count" must be greater than or equal to 1'
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
  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.