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

# Read company



## OpenAPI

````yaml /openapi.json get /v1/models/company/{id}
openapi: 3.1.0
info:
  title: Ablo Sync Engine HTTP API
  version: 0.16.1
  description: >-
    The HTTP surface of the Ablo sync engine. Most production traffic flows over
    WebSocket via `@abloatai/ablo`; this HTTP API is the Vercel-safe transport
    for environments that cannot hold long-lived sockets, plus the control plane
    for capabilities and usage.


    The per-model resource routes (`/v1/models/{model}`) are **generated from
    your own pushed schema** — they are documented here generically over
    `{model}`, with `tasks` as the running example. Authenticate every request
    with a `Bearer` API key or scoped token.
servers:
  - url: https://api.abloatai.com/api
    description: Production
  - url: http://localhost:8787/api
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Records
    description: Typed CRUD over any model in your schema.
  - name: Coordination
    description: Claims — pessimistic row reservation for human+agent coordination.
  - name: State
    description: Atomic multi-model commits.
  - name: Control plane
    description: Capabilities and usage.
paths:
  /v1/models/company/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Record id.
    get:
      tags:
        - Models
      summary: Read company
      operationId: get_company
      responses:
        '200':
          description: The company record.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    const: model
                  model:
                    type: string
                    const: company
                  id:
                    type: string
                  data:
                    $ref: '#/components/schemas/Company'
                  stamp:
                    type: integer
                  claims:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelClaim'
        '404':
          description: Not found or out of scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Company:
      type: object
      properties:
        id:
          type: string
          description: Server-assigned row id.
        name:
          type: string
        domain:
          anyOf:
            - type: string
            - type: 'null'
        industry:
          anyOf:
            - type: string
            - type: 'null'
        type:
          default: corporation
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
        size:
          anyOf:
            - type: string
            - type: 'null'
        headquarters:
          anyOf:
            - type: string
            - type: 'null'
        status:
          default: active
          type: string
        metadata:
          anyOf:
            - type: string
            - type: 'null'
        updatedBy:
          anyOf:
            - type: string
            - type: 'null'
        archivedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      required:
        - name
        - type
        - status
      additionalProperties: false
      description: A `company` record as returned by reads.
      x-generated: commit-inputs
    ModelClaim:
      type: object
      required:
        - id
        - actor
        - participantKind
        - reason
        - status
        - expiresAt
        - target
      properties:
        id:
          type: string
        actor:
          type: string
        participantKind:
          type: string
          enum:
            - user
            - agent
            - system
        reason:
          type: string
        description:
          type: string
        field:
          type: string
        status:
          type: string
          enum:
            - active
            - queued
        position:
          type: integer
        expiresAt:
          type: integer
        target:
          type: object
          required:
            - model
            - id
          properties:
            model:
              type: string
            id:
              type: string
            path:
              type: string
            field:
              type: string
            meta:
              type: object
              additionalProperties: true
      x-generated: commit-inputs
    Error:
      type: object
      required:
        - type
        - message
      description: >-
        Canonical error envelope. Every HTTP error response and every WebSocket
        frame error carries these fields.
      properties:
        type:
          type: string
          description: >-
            Coarse error class (e.g. `AbloValidationError`,
            `AbloPermissionError`).
        code:
          type: string
          description: Stable machine code for the specific error.
        param:
          type: string
          description: Offending model/field path, when parameter-specific.
        message:
          type: string
          description: Human-readable explanation.
        doc_url:
          type: string
          description: Link to the docs page for this code.
        request_id:
          type: string
          description: >-
            Request correlation id, echoed on the `x-request-id` response
            header.
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key (`sk_live_…`) or a scoped capability/ephemeral token. The same
        header carries both — the server discriminates by token shape.

````