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

# Get workspace for API key

> Smoke-test the key and read plan entitlements.



## OpenAPI

````yaml /openapi/integrations.json get /integrations/me
openapi: 3.1.0
info:
  title: Vendschat Integration API
  version: '1.0'
  description: >
    Workspace API for Zapier, Make, n8n, and custom HTTP clients.

    Authenticate with a Growth+ integration API key. Keys only authorize
    `/v1/integrations/*`.
  contact:
    name: Vendschat
    url: https://vendschat.com
servers:
  - url: https://api.vendschat.com/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Auth
    description: Verify API keys and workspace entitlements
  - name: Messages
    description: Channels, templates, and outbound sends
  - name: Contacts
    description: Lookup and manage contacts
  - name: Labels
    description: Workspace labels
  - name: Webhooks
    description: REST Hook subscribe lifecycle for Zapier, Make, and n8n
  - name: Platform helpers
    description: >-
      Dynamic form helpers for Zapier/Make connectors — prefer Messages send for
      custom HTTP
paths:
  /integrations/me:
    get:
      tags:
        - Auth
      summary: Get workspace for API key
      description: Smoke-test the key and read plan entitlements.
      operationId: getIntegrationsMe
      responses:
        '200':
          description: Workspace and entitlements
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResponse'
              example:
                workspace:
                  id: 42
                  name: BloomBox
                  organization_id: 7
                  organization_name: BloomBox Ltd
                  plan_tier: growth_200
                entitlements:
                  webhooks: true
                  integrations: true
                  developer_api: false
                  feature_access:
                    - inbox.chat
                    - settings.integrations
                    - settings.webhooks
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    MeResponse:
      type: object
      required:
        - workspace
        - entitlements
      properties:
        workspace:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            organization_id:
              type: integer
            organization_name:
              type: string
            plan_tier:
              type: string
        entitlements:
          type: object
          properties:
            webhooks:
              type: boolean
            integrations:
              type: boolean
            developer_api:
              type: boolean
            feature_access:
              type: array
              items:
                type: string
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: '`Authorization: Bearer YOUR_API_KEY`'
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative to Bearer auth

````

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