> ## 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.

# Check an API key

> Returns the key and its business. Any valid key can call it, whatever its scopes, so integrations use it to test a connection.



## OpenAPI

````yaml /api-reference/openapi.json get /me
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. Each key allows 120 requests per minute by default.
servers:
  - url: https://app.lobbystack.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Business
  - name: Calls
  - name: Contacts
  - name: Appointments
  - name: Messages
  - name: Knowledge
  - name: Webhooks
paths:
  /me:
    get:
      tags:
        - Business
      summary: Check an API key
      description: >-
        Returns the key and its business. Any valid key can call it, whatever
        its scopes, so integrations use it to test a connection.
      operationId: getMe
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/Me'
        '400':
          description: The request is invalid (invalid_request).
          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'
        '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:
    Me:
      description: The API key making the request and the business it belongs to.
      type: object
      properties:
        api_key:
          type: object
          properties:
            id:
              description: Stable identifier (UUID).
              type: string
              format: uuid
            name:
              type: string
            prefix:
              description: The visible start of the key, for example lsk_1a2b3c4d.
              type: string
            scopes:
              type: array
              items:
                type: string
                enum:
                  - business:read
                  - business:write
                  - calls:read
                  - contacts:read
                  - contacts:write
                  - appointments:read
                  - appointments:write
                  - messages:read
                  - knowledge:write
                  - webhooks:manage
            created_at:
              description: ISO 8601 timestamp in UTC.
              type: string
              format: date-time
          required:
            - id
            - name
            - prefix
            - scopes
            - created_at
          additionalProperties: false
        business:
          type: object
          properties:
            id:
              description: Stable identifier (UUID).
              type: string
              format: uuid
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
      required:
        - api_key
        - business
      additionalProperties: false
    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
            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. Scopes: business:read,
        business:write, calls:read, contacts:read, contacts:write,
        appointments:read, appointments:write, messages:read, knowledge:write,
        webhooks:manage.

````