openapi: 3.2.0
info:
  contact:
    email: hello@entergram.com
    name: Entergram
  description: Secure, workspace-scoped API for Entergram PRO. Use API keys created in Settings > Developers to access workspace metadata, accounts, contacts, groups, chats, custom fields, and tickets through a stable, documented contract.
  title: Entergram Public Workspace API
  version: v1
security:
- ApiKeyAuth: []
tags:
- description: Workspace metadata and feature access.
  name: Workspace
paths:
  /v1/workspace:
    get:
      description: 'Required scopes: `workspace.read`.'
      operationId: get-workspace
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceEnvelope'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Get current workspace metadata
      tags:
      - Workspace
      x-required-scopes:
      - workspace.read
  /v1/workspace/access:
    get:
      operationId: check-workspace-access
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessOutputBody'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      summary: Check current workspace access
      tags:
      - Workspace
components:
  schemas:
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    WorkspaceSummary:
      additionalProperties: false
      properties:
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        name:
          type: string
        planTier:
          type: string
      required:
      - id
      - name
      - planTier
      - createdAt
      type: object
    DataStruct:
      additionalProperties: false
      properties:
        allowed:
          type: boolean
      required:
      - allowed
      type: object
    AccessOutputBody:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/DataStruct'
      required:
      - data
      type: object
    WorkspaceEnvelope:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/WorkspaceSummary'
      required:
      - data
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
          - array
          - 'null'
        instance:
          description: A URI reference that identifies the specific occurrence of the problem.
          examples:
          - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
          - 400
          format: int64
          type: integer
        title:
          description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
          examples:
          - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
          - https://example.com/errors/example
          format: uri
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Workspace-scoped PRO API key created in Entergram Settings > Developers.
      in: header
      name: X-API-Key
      type: apiKey
x-entergram-scopes:
- workspace.read
- members.read
- accounts.read
- contacts.read
- chats.read
- chats.write
- messages.read
- messages.write
- custom_fields.read
- custom_fields.write
- tickets.read
- tickets.write
- events.read
- webhooks.read
- webhooks.write