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

# Get the current team

> ### Overview

Returns the current team, its owner, your role and permissions under `active`. `teams` lists the teams you can access, with owned teams first. The remaining fields count owned teams, memberships and teams other than the current one. Leaving or deleting a team selects the account's default team.

### Permissions

Requires the account permission `teams.read` (View teams).



## OpenAPI

````yaml https://console.advinservers.com/docs/openapi.json get /teams/context
openapi: 3.1.0
info:
  title: API reference
  version: 1.0.0
  description: >-
    Use this API to manage your team's servers, networks, backups, and other
    resources.


    ## Authentication


    Create an API key under **API Keys** and send it as a bearer token with
    every request:


    ```

    Authorization: Bearer {YOUR_API_KEY}

    Accept: application/json

    ```


    Copy the key when you create it. It cannot be shown again. Revoking a key
    takes effect immediately.


    ## Permissions


    Give each key only the permissions it needs. Every endpoint lists the
    required permission.


    Permissions cover servers and other resources in the key's team.


    ## Team scope


    A key can access resources in the team selected when it was created. This
    includes servers,

    snapshots, backups, firewall groups, images, SSH keys, scripts, networks and
    addresses.

    Resources in other teams return `404 Not Found`. Create a separate key for
    each team.


    The key determines the team for every request. Legacy keys that had no team
    are assigned

    to the account's first owned team.


    ## Actions that need the panel


    API keys cannot do the following, even with every permission. Sign in to the
    panel in a

    browser to do them:


    - Create, edit or revoke API keys

    - Edit the IP groups that restrict API keys

    - End signed-in sessions

    - Change two-factor authentication

    - Change the account's email address

    - Accept or decline team invitations

    - Switch or leave a team


    This keeps a leaked key from widening its own access or locking you out of
    your account.


    ## Source IP restrictions


    A key can be restricted to one or more IP groups. Requests from other
    addresses are rejected.


    ## Requests and responses


    Each endpoint lists its path, query, header, and body parameters. Examples
    use fictional data.


    Single records use JSON objects. Collections use JSON arrays unless the
    endpoint supports pagination. Timestamps use ISO 8601 in UTC.


    Error responses include `message`. Validation errors also include an
    `errors` object for each field. Each endpoint lists its status codes.


    ## Audit log


    Every API request, including reads, is recorded in the account audit log
    with the key that made it.
servers:
  - url: https://console.advinservers.com/api/v1/client
security:
  - http: []
tags:
  - name: Account
    description: Billing contact details and account setup progress.
  - name: Account activity
    description: Actions performed in the current team by people and API keys.
  - name: Servers
    description: >-
      Order and list servers, read their state and resource use, open a console,
      and control power.
  - name: Server settings
    description: >-
      Rename a server, rebuild it, and change its hardware, media, resolvers and
      credentials.
  - name: Backups
    description: Scheduled server copies stored separately from the server.
  - name: Snapshots
    description: >-
      Take, restore and move server snapshots. Snapshots are kept in snapshot
      storage that the team buys by the GiB.
  - name: Firewall groups
    description: Reusable sets of firewall rules, and the servers they apply to.
  - name: IP groups
    description: Reusable source address lists for firewall rules.
  - name: Server firewall
    description: >-
      Read default traffic policies and rules managed outside your firewall
      groups.
  - name: IP addresses
    description: Manage floating IPs and server address assignments.
  - name: Private networks
    description: Connect servers over a private network in the same location.
  - name: Reverse DNS
    description: Set the hostnames returned by IP address lookups.
  - name: DDoS protection
    description: Configure attack filtering for server addresses.
  - name: Bandwidth
    description: Buy extra bandwidth and share it between servers or location pools.
  - name: SSH keys
    description: Public keys the account can install on a server when it is built.
  - name: Setup scripts
    description: Scripts the account can run on a server when it is built.
  - name: ISO images
    description: ISO images you have downloaded, and the servers they are mounted on.
  - name: Server upgrades
    description: Change an existing server's plan.
  - name: Checkout
    description: Choose a payment method and pay for a purchase.
  - name: Invoices
    description: View and pay account invoices.
  - name: Billing
    description: Manage service renewals, payment methods and account credit.
  - name: Transfers
    description: Move resources between teams or transfer ownership.
  - name: Teams
    description: Manage the team assigned to your API key.
  - name: Team members
    description: Invite people and manage their team access.
  - name: Team roles
    description: Define the permissions granted to team members.
  - name: Team activity
    description: View actions performed in a team.
  - name: Support tickets
    description: >-
      Open, read, reply to and close support tickets. Tickets belong to the
      account holder and are not shared with team members.
paths:
  /teams/context:
    get:
      tags:
        - Teams
      summary: Get the current team
      description: >-
        ### Overview


        Returns the current team, its owner, your role and permissions under
        `active`. `teams` lists the teams you can access, with owned teams
        first. The remaining fields count owned teams, memberships and teams
        other than the current one. Leaving or deleting a team selects the
        account's default team.


        ### Permissions


        Requires the account permission `teams.read` (View teams).
      operationId: client.teams.context
      responses:
        '200':
          description: The record, as a JSON object. There is no envelope.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - active:
                      id: fbb31f5f-bd6f-4019-a3ed-1062a28f56f7
                      name: Anomalous Materials
                      is_owner: true
                      owner:
                        name: Gordon Freeman
                        email: gordon.freeman@blackmesa.example.com
                      role: null
                      permissions:
                        - team.read
                        - team.manage
                        - server.read
                        - server.power
                        - server.console
                        - server.update
                        - server.credentials
                        - server.reinstall
                        - server.transfer
                        - backup.read
                        - backup.create
                        - backup.restore
                        - backup.delete
                        - snapshot.read
                        - snapshot.create
                        - snapshot.restore
                        - snapshot.delete
                        - snapshot.update
                        - snapshot.transfer
                        - firewall.read
                        - firewall.update
                        - firewall.delete
                        - network.read
                        - network.update
                        - network.transfer
                        - network.delete
                        - sshkey.read
                        - sshkey.update
                        - sshkey.delete
                        - script.read
                        - script.update
                        - script.delete
                        - iso.read
                        - iso.update
                        - iso.delete
                        - measured_boot.read
                        - measured_boot.update
                        - measured_boot.delete
                        - billing.read
                        - billing.manage
                        - billing.purchase
                    teams:
                      - id: fbb31f5f-bd6f-4019-a3ed-1062a28f56f7
                        name: Anomalous Materials
                        is_owner: true
                        is_default: true
                        is_active: true
                        role: null
                      - id: 48454223-c5ac-461f-bead-ba8dda13eea9
                        name: Lambda Complex
                        is_owner: true
                        is_default: false
                        is_active: false
                        role: null
                    owned_team_count: 2
                    membership_count: 0
                    other_team_count: 1
                properties:
                  active:
                    type: object
                    description: The team this request is working in.
                    examples:
                      - id: fbb31f5f-bd6f-4019-a3ed-1062a28f56f7
                        name: Anomalous Materials
                        is_owner: true
                        owner:
                          name: Gordon Freeman
                          email: gordon.freeman@blackmesa.example.com
                        role: null
                        permissions:
                          - team.read
                          - team.manage
                          - server.read
                          - server.power
                          - server.console
                          - server.update
                          - server.credentials
                          - server.reinstall
                          - server.transfer
                          - backup.read
                          - backup.create
                          - backup.restore
                          - backup.delete
                          - snapshot.read
                          - snapshot.create
                          - snapshot.restore
                          - snapshot.delete
                          - snapshot.update
                          - snapshot.transfer
                          - firewall.read
                          - firewall.update
                          - firewall.delete
                          - network.read
                          - network.update
                          - network.transfer
                          - network.delete
                          - sshkey.read
                          - sshkey.update
                          - sshkey.delete
                          - script.read
                          - script.update
                          - script.delete
                          - iso.read
                          - iso.update
                          - iso.delete
                          - measured_boot.read
                          - measured_boot.update
                          - measured_boot.delete
                          - billing.read
                          - billing.manage
                          - billing.purchase
                    properties:
                      id:
                        type: string
                        description: The team's id.
                        examples:
                          - fbb31f5f-bd6f-4019-a3ed-1062a28f56f7
                      name:
                        type: string
                        description: What the team is called.
                        examples:
                          - Anomalous Materials
                      is_owner:
                        type: boolean
                        description: >-
                          True when the account owns this team rather than
                          having been invited into it.
                        examples:
                          - true
                      owner:
                        type: object
                        description: >-
                          The account the team belongs to. Both fields are null
                          if that account has gone.
                        examples:
                          - name: Gordon Freeman
                            email: gordon.freeman@blackmesa.example.com
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            description: The name shown to customers.
                            examples:
                              - Gordon Freeman
                          email:
                            type:
                              - string
                              - 'null'
                            description: The email address.
                            examples:
                              - gordon.freeman@blackmesa.example.com
                        required:
                          - name
                          - email
                      role:
                        type:
                          - object
                          - 'null'
                        description: >-
                          The role you hold here, or null when you own the team:
                          ownership is not a role.
                        examples:
                          - null
                        properties:
                          id:
                            type: string
                            description: The id ID.
                            examples:
                              - ecc6f4f1
                          name:
                            type: string
                            description: The name shown to customers.
                            examples:
                              - lambda-core
                        required:
                          - id
                          - name
                      permissions:
                        type: array
                        description: >-
                          The permission keys you hold here. An account holder
                          holds every key there is.
                        examples:
                          - - team.read
                            - team.manage
                            - server.read
                            - server.power
                            - server.console
                            - server.update
                            - server.credentials
                            - server.reinstall
                            - server.transfer
                            - backup.read
                            - backup.create
                            - backup.restore
                            - backup.delete
                            - snapshot.read
                            - snapshot.create
                            - snapshot.restore
                            - snapshot.delete
                            - snapshot.update
                            - snapshot.transfer
                            - firewall.read
                            - firewall.update
                            - firewall.delete
                            - network.read
                            - network.update
                            - network.transfer
                            - network.delete
                            - sshkey.read
                            - sshkey.update
                            - sshkey.delete
                            - script.read
                            - script.update
                            - script.delete
                            - iso.read
                            - iso.update
                            - iso.delete
                            - measured_boot.read
                            - measured_boot.update
                            - measured_boot.delete
                            - billing.read
                            - billing.manage
                            - billing.purchase
                        items:
                          type: string
                          examples:
                            - ''
                    required:
                      - id
                      - name
                      - is_owner
                      - owner
                      - role
                      - permissions
                  teams:
                    type: array
                    description: >-
                      Every team the account can work in, the ones it owns first
                      and its default first among those.
                    examples:
                      - - id: fbb31f5f-bd6f-4019-a3ed-1062a28f56f7
                          name: Anomalous Materials
                          is_owner: true
                          is_default: true
                          is_active: true
                          role: null
                        - id: 48454223-c5ac-461f-bead-ba8dda13eea9
                          name: Lambda Complex
                          is_owner: true
                          is_default: false
                          is_active: false
                          role: null
                    items:
                      type: object
                      examples:
                        - id: fbb31f5f-bd6f-4019-a3ed-1062a28f56f7
                          name: Anomalous Materials
                          is_owner: true
                          is_default: true
                          is_active: true
                          role: null
                      properties:
                        id:
                          type: string
                          description: The team's UUID.
                          examples:
                            - fbb31f5f-bd6f-4019-a3ed-1062a28f56f7
                        name:
                          type: string
                          description: What the team is called.
                          examples:
                            - Anomalous Materials
                        is_owner:
                          type: boolean
                          description: >-
                            True when the account owns this team rather than
                            having been invited into it.
                          examples:
                            - true
                        is_default:
                          type: boolean
                          description: >-
                            True for the account's default team, which is where
                            anything created without naming a team lands.
                          examples:
                            - true
                        is_active:
                          type: boolean
                          description: True for the team this request is working in.
                          examples:
                            - true
                        role:
                          type:
                            - object
                            - 'null'
                          description: >-
                            The role held here, or null when the account owns
                            the team: ownership is not a role.
                          examples:
                            - null
                          properties:
                            id:
                              type: string
                              description: The id ID.
                              examples:
                                - ecc6f4f1
                            name:
                              type: string
                              description: The name shown to customers.
                              examples:
                                - lambda-core
                          required:
                            - id
                            - name
                      required:
                        - id
                        - name
                        - is_owner
                        - is_default
                        - is_active
                        - role
                  owned_team_count:
                    type: integer
                    description: How many teams the account owns.
                    examples:
                      - 2
                  membership_count:
                    type: integer
                    description: How many teams the account has been invited into.
                    examples:
                      - 0
                  other_team_count:
                    type: integer
                    description: Those two added together, less the one this request is in.
                    examples:
                      - 1
                required:
                  - active
                  - teams
                  - owned_team_count
                  - membership_count
                  - other_team_count
        '401':
          description: >-
            The key was missing, malformed, revoked, or belongs to an account
            that no longer exists.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Unauthenticated.
                required:
                  - message
        '403':
          description: >-
            Access denied. Check the key's team, permissions and allowed IP
            addresses. Some actions, such as managing API keys, require a
            browser session. The response message explains the reason.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - >-
                        This API key is not allowed to do that in this team. It
                        needs the "snapshot.delete" permission.
                required:
                  - message
        '429':
          description: >-
            Too many requests. The `Retry-After` header says how many seconds to
            wait. Limits are per account, so several keys on one account share
            them.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    examples:
                      - Too Many Attempts.
                required:
                  - message
components:
  securitySchemes:
    http:
      type: http
      description: >-
        Your API key, sent as a bearer token. Create one in the control panel
        under API Keys, give it only the permissions the integration needs, and
        copy it when it is created. It cannot be shown again. Each key is
        restricted to one owned team. The key determines the team for every
        request.
      scheme: bearer

````

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