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

# Status



## OpenAPI

````yaml api-reference/openapi.yaml GET /status
openapi: 3.1.0
info:
  title: TrailerCast Integration API
  version: 1.0.0
  summary: >-
    Read-only access to call summaries, prospect engagement and Decision Room
    metrics, plus signed webhooks.
  description: >
    Read-only, workspace-scoped API for pulling the deal signals TrailerCast
    captures during a sale,

    and outbound webhooks for near-real-time notification. Start with the guides
    in this section (Introduction, Quickstart, Authentication, Webhooks); the
    endpoint pages below are generated from this spec.


    **Authentication.** Data endpoints take an API key: `Authorization: Bearer
    tck_live_…`.

    Management endpoints take an admin session JWT with the `integrations.crm`
    permission.


    **Pagination.** Every list is keyset-paginated and ascending: `{ data,
    nextCursor, hasMore }`.

    Pass `cursor=<nextCursor>` to continue. `limit` 1–500, default 100.


    **Rate limit.** 300 requests/minute per API key; `429` with `Retry-After`
    when exceeded.


    **Versioning.** Breaking changes ship as a new path (`/api/v2`). Additive
    changes (new fields,

    event types, parameters) may ship at any time; ignore what you do not
    recognise.
  contact:
    name: TrailerCast
    url: https://trailercast.io
servers:
  - url: https://{host}/api/v1
    variables:
      host:
        default: trailercst-backend-production.up.railway.app
        description: Your TrailerCast API host.
  - url: http://localhost:5000/api/v1
    description: Local development
security:
  - apiKey: []
tags:
  - name: Status
  - name: Calls
  - name: Engagement
  - name: Decision Rooms
  - name: Webhook deliveries
  - name: Management — API keys
  - name: Management — Webhooks
paths:
  /status:
    get:
      tags:
        - Status
      summary: Confirm the key works and report webhook health
      operationId: getStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotEnabled'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Status:
      type: object
      properties:
        ok:
          type: boolean
        apiVersion:
          type: string
          example: '2026-09-01'
        company:
          type: object
          properties:
            id:
              type: integer
            name:
              type:
                - string
                - 'null'
        key:
          type: object
          properties:
            prefix:
              type: string
              example: tck_live_Ab1
            name:
              type:
                - string
                - 'null'
            scopes:
              type: array
              items:
                type: string
            createdAt:
              type:
                - string
                - 'null'
              format: date-time
            lastUsedAt:
              type:
                - string
                - 'null'
              format: date-time
        webhooks:
          type: object
          properties:
            endpoints:
              type: integer
            enabledEndpoints:
              type: integer
            pendingDeliveries:
              type: integer
            deadDeliveries:
              type: integer
            lastDeliveredAt:
              type:
                - string
                - 'null'
              format: date-time
        rateLimit:
          type: object
          properties:
            perMinute:
              type: integer
              example: 300
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable; not stable.
        code:
          type: string
          description: Stable machine code.
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or revoked API key; or a session token on a data
        endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid API key.
            code: API_KEY_INVALID
    FeatureNotEnabled:
      description: The Integration API is not enabled for this workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: The Integration API is not enabled for this workspace.
            code: FEATURE_NOT_ENABLED
    RateLimited:
      description: Rate limit exceeded (300/min per key)
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: tck_live_…
      description: Workspace API key minted via POST /api-keys. Read-only.

````