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

# Get workspace

> Check which Tapify Teams workspace an API key belongs to.

Use this as your first request. It confirms that the API key works and shows which workspace it can access.

<Note>
  An API key cannot switch between workspaces. Create a separate key in each workspace that an integration needs to access.
</Note>


## OpenAPI

````yaml api-reference/openapi.json GET /me
openapi: 3.0.3
info:
  title: Tapify API
  version: 1.0.0
  description: Manage team members and contacts in a Tapify Teams workspace.
servers:
  - url: https://tapify.app/api/v1
    description: Tapify API
security:
  - bearerAuth: []
tags:
  - name: Workspace
    description: Check the workspace connected to an API key.
  - name: Team members
    description: Manage members and their digital business cards.
  - name: Contacts
    description: Manage contacts collected across the workspace.
paths:
  /me:
    get:
      tags:
        - Workspace
      summary: Get workspace
      description: Checks the API key and returns the workspace it can access.
      operationId: getWorkspace
      responses:
        '200':
          description: Workspace information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    WorkspaceResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - apiKeyId
            - workspace
          properties:
            apiKeyId:
              type: string
              format: uuid
              description: ID of the API key used for this request.
              example: 4c69681a-02d9-4c73-8c21-6d4489c0879f
            workspace:
              $ref: '#/components/schemas/Workspace'
    Workspace:
      type: object
      description: The workspace connected to the API key.
      required:
        - id
        - name
        - domain
      properties:
        id:
          type: string
          format: uuid
          description: Unique workspace ID.
          example: 9df81bd4-3d76-42cc-9518-a019ea75a221
        name:
          type: string
          example: Acme
        domain:
          type: string
          nullable: true
          description: Custom domain used for digital business cards, when configured.
          example: card.acme.com
    ErrorResponse:
      type: object
      description: Information about a request that Tapify could not complete.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Short code that identifies the error.
              example: bad_request
            message:
              type: string
              description: Readable explanation of what went wrong.
              example: Request body is invalid.
            details:
              type: object
              description: Extra information that can help fix the request.
              additionalProperties: true
              nullable: true
  responses:
    Unauthorized:
      description: The API key is missing, incorrect, or deleted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Too many requests were sent in a short period.
      headers:
        Retry-After:
          description: Seconds to wait before trying again.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Tapify could not complete the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Tapify API key
      description: API key created under Settings → API keys.

````