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

# Workspace abrufen

> Prüfe deinen API-Schlüssel und den Workspace, auf den er zugreifen kann.

Verwende diesen Endpunkt für deine erste Anfrage. Er liefert die ID des Schlüssels sowie ID, Name und eigene Domain des Workspaces. `domain` ist `null`, wenn keine eigene Domain eingerichtet ist.

Die Antwort beschreibt den Workspace, keine einzelne Person. Prüfe sie, bevor du Daten importierst oder änderst.

> [!NOTE]
>
> Jeder API-Schlüssel gehört zu einem Workspace. Wenn du einen weiteren Workspace anbinden möchtest, erstelle dort einen Schlüssel und verwende ihn für die Anfragen an diesen Workspace.


## OpenAPI

````yaml de/api-reference/openapi.json GET /me
openapi: 3.0.3
info:
  title: Tapify-API
  version: 1.0.0
  description: >-
    Lies und verwalte gespeicherte Kontakte, Teammitglieder und ihre digitalen
    Visitenkarten in einem Tapify-Teams-Workspace. Erfordert Zugriff auf Teams
    Connect und einen API-Schlüssel für den Workspace.
servers:
  - url: https://tapify.app/api/v1
    description: Tapify-API
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Workspace
    description: Den mit einem API-Schlüssel verbundenen Workspace prüfen.
  - name: Teammitglieder
    description: Mitglieder und ihre digitalen Visitenkarten verwalten.
  - name: Kontakte
    description: Im gesamten Workspace erfasste Kontakte verwalten.
  - name: Zapier
    description: >-
      Endpunkte, die die Tapify-Zapier-Integration für Trigger-Beispiele und
      REST-Hook-Abonnements verwendet.
paths:
  /me:
    get:
      tags:
        - Workspace
      summary: Workspace abrufen
      description: >-
        Prüft den API-Schlüssel und gibt den Workspace zurück, auf den er
        Zugriff hat.
      operationId: getWorkspace
      responses:
        '200':
          description: Workspace-Informationen
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
              example:
                data:
                  apiKeyId: 4c69681a-02d9-4c73-8c21-6d4489c0879f
                  workspace:
                    id: 9df81bd4-3d76-42cc-9518-a019ea75a221
                    name: Acme
                    domain: card.acme.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/SubscriptionRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '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 des für diese Anfrage verwendeten API-Schlüssels.
              example: 4c69681a-02d9-4c73-8c21-6d4489c0879f
            workspace:
              $ref: '#/components/schemas/Workspace'
    Workspace:
      type: object
      description: Der mit dem API-Schlüssel verbundene Workspace.
      required:
        - id
        - name
        - domain
      properties:
        id:
          type: string
          format: uuid
          description: Eindeutige Workspace-ID.
          example: 9df81bd4-3d76-42cc-9518-a019ea75a221
        name:
          type: string
          example: Acme
        domain:
          type: string
          nullable: true
          description: Eigene Domain für digitale Visitenkarten, sofern eingerichtet.
          example: card.acme.com
    ErrorResponse:
      type: object
      description: Informationen zu einer Anfrage, die Tapify nicht abschließen konnte.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Kurzer Code zur Identifizierung des Fehlers.
              example: bad_request
            message:
              type: string
              description: Verständliche Erklärung des Fehlers.
              example: Request body is invalid.
            details:
              type: object
              description: >-
                Zusätzliche Informationen, die beim Korrigieren der Anfrage
                helfen können.
              additionalProperties: true
              nullable: true
  responses:
    Unauthorized:
      description: Der API-Schlüssel fehlt, ist falsch oder wurde gelöscht.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: invalid_api_key
              message: API key is invalid or revoked.
    SubscriptionRequired:
      description: >-
        Der Workspace benötigt Zugriff auf Teams Connect. Prüfe seinen Tarif,
        den Abonnementstatus und den Ablauf der Testphase.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: subscription_required
              message: Tapify Teams Connect is required for this feature.
    NotFound:
      description: Der angeforderte Eintrag ist in diesem Workspace nicht vorhanden.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: Contact was not found.
    RateLimited:
      description: In kurzer Zeit wurden zu viele Anfragen gesendet.
      headers:
        Retry-After:
          description: Wartezeit in Sekunden vor einem erneuten Versuch.
          schema:
            type: integer
            example: 30
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded.
              details:
                retryAfter: 30
    InternalError:
      description: Tapify konnte die Anfrage nicht abschließen.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: internal_error
              message: Something went wrong.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Tapify API key
      description: Unter Einstellungen → API-Schlüssel erstellter API-Schlüssel.
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Alternative zu Authorization: Bearer. Sende pro Anfrage nur eine
        Authentifizierungsmethode; ein Bearer-Token hat Vorrang.

````

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