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

# Get the team

> Everyone on the team and the invitations still open.



## OpenAPI

````yaml /api-reference/openapi.json get /team
openapi: 3.1.0
info:
  title: LobbyStack API
  version: v1
  description: >-
    Read calls, contacts, appointments and messages, book appointments, and
    subscribe to webhooks. Authenticate with an API key in the Authorization
    header. A platform key also names the business it acts on in the
    LobbyStack-Business header. Each key allows 120 requests per minute by
    default.
servers:
  - url: https://app.lobbystack.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Business
  - name: Receptionist
  - name: Billing
  - name: Phone numbers
  - name: Onboarding
  - name: Team
  - name: Website chat
  - name: Calendars
  - name: Notifications
  - name: Calls
  - name: Contacts
  - name: Appointments
  - name: Messages
  - name: Knowledge
  - name: Webhooks
  - name: Platform
paths:
  /team:
    get:
      tags:
        - Team
      summary: Get the team
      description: Everyone on the team and the invitations still open.
      operationId: getTeam
      parameters:
        - name: LobbyStack-Business
          in: header
          description: >-
            The business a platform key acts on. Required with a platform key. A
            per-business key may leave it out; if it sends one, it must be the
            key's own business.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/Team'
        '400':
          description: >-
            The request is invalid (invalid_request), or a platform key sent no
            LobbyStack-Business header (business_required).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key is missing, invalid, or revoked (unauthorized).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Refused. insufficient_scope: the key lacks the team:manage scope.
            forbidden: a per-business key named another business in
            LobbyStack-Business. key_owner_inactive: the person the key acts for
            can't any more: a per-business key's creator is no longer an owner
            or admin, or a platform key's owner_email has no verified LobbyStack
            account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: A platform key named a business it cannot act on (not_found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Too many requests (rate_limited). Wait for the Retry-After header's
            number of seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait.
      security:
        - bearerAuth: []
components:
  schemas:
    Team:
      type: object
      properties:
        members:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: The membership id.
              user_id:
                type: string
                format: uuid
                description: Stable identifier (UUID).
              name:
                type:
                  - string
                  - 'null'
              email:
                type: string
              role:
                type: string
                enum:
                  - business_owner
                  - business_admin
                  - scheduler
                  - viewer
              joined_at:
                type: string
                format: date-time
                description: ISO 8601 timestamp in UTC.
            required:
              - id
              - user_id
              - name
              - email
              - role
              - joined_at
            additionalProperties: false
            description: Someone on the business's team.
          description: Everyone on the team, earliest first.
        invitations:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: Stable identifier (UUID).
              email:
                type: string
              role:
                type: string
                enum:
                  - business_owner
                  - business_admin
                  - scheduler
                  - viewer
              status:
                type: string
                enum:
                  - pending
                  - expired
                description: >-
                  pending: waiting to be accepted. expired: can no longer be
                  accepted; send a new one.
              transfers_ownership:
                type: boolean
                description: >-
                  true for a claim link: accepting it makes the invitee an owner
                  and takes the account that sent it off the team.
              expires_at:
                type: string
                format: date-time
                description: ISO 8601 timestamp in UTC.
              created_at:
                type: string
                format: date-time
                description: ISO 8601 timestamp in UTC.
            required:
              - id
              - email
              - role
              - status
              - transfers_ownership
              - expires_at
              - created_at
            additionalProperties: false
            description: An invitation nobody has accepted yet.
          description: Invitations nobody has accepted or revoked, newest first.
      required:
        - members
        - invitations
      additionalProperties: false
      description: The business's team and its open invitations.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - insufficient_scope
                - not_found
                - conflict
                - idempotency_key_reused
                - idempotency_request_in_progress
                - booking_disabled
                - booking_requires_confirmation
                - slot_unavailable
                - rate_limited
                - rate_limit_unavailable
                - method_not_allowed
                - internal_error
                - business_required
                - key_owner_inactive
                - plan_limit_reached
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
                required:
                  - path
                  - message
                additionalProperties: false
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Settings > API keys (lsk_...), which acts on its own
        business, or a platform key from the PLATFORM_API_KEYS setting
        (lsp_...), which onboards and manages businesses. Scopes: business:read,
        business:write, calls:read, contacts:read, contacts:write,
        appointments:read, appointments:write, messages:read, knowledge:read,
        knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage,
        team:manage, businesses:create, users:create. Only platform keys can
        hold businesses:create and users:create.

````

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