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

# Get the snapshot

> The company now: office states, active items, the line at the door, spend today and items shipped in 7 days.


## OpenAPI

```yaml openapi.json get /v1/companies/{campus}/snapshot
openapi: 3.1.0
info:
  title: Ocean One API
  version: 2.4.0
servers:
  - url: https://api.plungeai.com
paths:
  /v1/companies/{campus}/snapshot:
    get:
      operationId: get-v1-companies-campus-snapshot
      tags:
        - Companies
      summary: The company now
      description: "State with `head_seq`: each office idle, running, waiting or offline, the active items, the line at the door, spend today and items shipped in 7 days. Fold GET …/events over it, dropping `seq <= head_seq`."
      security:
        - ozkBearer: []
      parameters:
        - name: campus
          in: path
          required: true
          schema:
            type: string
          description: The company’s slug (`plunge`), never a row id
        - name: format
          in: query
          schema:
            type: string
            enum:
              - json
              - yaml
              - markdown
              - text
          description: Response format; overrides Accept (an unknown value is 400 invalid_format)
      responses:
        "200":
          description: The snapshot Response format negotiates via the `format` field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.
          content:
            application/json:
              schema:
                type: object
                properties:
                  head_seq:
                    type: integer
                    description: "Drop events with seq <= head_seq when folding them over this snapshot. Read before the state, so a later event may already show in it: fold idempotently"
                  mode:
                    type: string
                    enum:
                      - supervised
                      - tiered
                      - autonomous
                  status:
                    type: string
                    enum:
                      - applied
                      - running
                      - stopped
                  buildings:
                    type: array
                    items:
                      type: object
                      properties:
                        slug:
                          type: string
                        location:
                          type: string
                          enum:
                            - cloud
                            - local
                        connected:
                          type: boolean
                        mode:
                          type: string
                          enum:
                            - supervised
                            - tiered
                            - autonomous
                        active:
                          type: integer
                  offices:
                    type: array
                    items:
                      type: object
                      properties:
                        building:
                          type: string
                        office:
                          type: string
                        state:
                          type: string
                          enum:
                            - idle
                            - running
                            - waiting
                            - offline
                        item_id:
                          type:
                            - string
                            - "null"
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        campus:
                          type: string
                        building:
                          type: string
                        title:
                          type: string
                        body:
                          type: string
                        kind:
                          type: string
                          enum:
                            - feature
                            - bugfix
                            - docs
                            - research
                            - content
                            - task
                        source:
                          type: string
                          enum:
                            - api
                            - bot
                            - schedule
                            - then
                            - node
                        priority:
                          type: integer
                        tier:
                          type:
                            - string
                            - "null"
                          description: The standard’s tier word (`T2`, `V1`); null until set
                        step:
                          type: string
                          description: "`intake`, a step id of the building’s pipeline, `done` or `parked`"
                        attempt:
                          type: integer
                        status:
                          type: string
                          enum:
                            - active
                            - done
                            - failed
                            - parked
                        parked_reason:
                          type:
                            - string
                            - "null"
                        paused:
                          type: integer
                          enum:
                            - 0
                            - 1
                        steer:
                          type:
                            - string
                            - "null"
                        last_output:
                          type:
                            - string
                            - "null"
                          description: The previous step’s output, the next office’s `{input}`
                        cost_usd:
                          type: number
                        parent_item_id:
                          type:
                            - string
                            - "null"
                        created_at:
                          type: string
                        updated_at:
                          type: string
                  queue:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        item_id:
                          type: string
                        building:
                          type: string
                        step:
                          type: string
                        gate:
                          type: string
                        tier:
                          type:
                            - string
                            - "null"
                        status:
                          type: string
                          enum:
                            - pending
                            - approved
                            - rejected
                            - expired
                        payload_json:
                          type: string
                        execution_id:
                          type:
                            - string
                            - "null"
                          description: "For a `tool_permission` gate raised inside an office: the paused execution"
                        requested_at:
                          type: string
                        expires_at:
                          type: string
                        decided_at:
                          type:
                            - string
                            - "null"
                        decided_by:
                          type:
                            - string
                            - "null"
                          description: "`auto`, `timeout`, `user:<id>`, `team:<id>` or `node`"
                        note:
                          type:
                            - string
                            - "null"
                    description: "The line at the door: pending approvals, oldest first"
                  truncated:
                    type: boolean
                    description: "true when a cap cut a list: `items` holds the newest 500, `queue` the oldest 200 pending approvals"
                  spend_today_usd:
                    type: number
                  shipped_7d:
                    type: integer
            text/yaml:
              schema:
                type: string
            text/markdown:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        "400":
          description: invalid_format — format must be one of json, yaml, markdown, text
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: unauthorized — missing, invalid or revoked ozk_ key
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "404":
          description: "company_not_found — no company with that slug for this account (a foreign slug answers the same); not_found — no route for this method on this path: every other method answers it"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "502":
          description: upstream_error — the company service is unavailable; retry
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: not_enabled — the company service is not deployed on this tier
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  schemas:
    Error:
      type: object
      description: Standard error envelope. Every error response also carries an `X-Error-Code` response header equal to error.code, so a client branches on the header regardless of the negotiated body format (json | yaml | markdown | text). When the request created an execution, the `X-Execution-Id` response header is also set. Errors follow the negotiated format like success bodies.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            connect:
              type: object
              description: "On a 424 connection_required / credential_required: where the missing connection is made."
              properties:
                provider:
                  type: string
                method:
                  type: string
                  enum:
                    - oauth
                    - api_key
                    - wallet
                link:
                  type: string
                  example: POST /v1/connections/stripe/link
          required:
            - code
            - message
          additionalProperties: true
      required:
        - error
  securitySchemes:
    ozkBearer:
      type: http
      scheme: bearer
      description: "ozk_ platform API key (Authorization: Bearer ozk_…)"
```
