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

# Read compact project Context

> Target-authorized version-1 summaries with separate authority, freshness, identity and explicit detail handles. Six default groups; Design and Discussion remain empty. No bodies, history or provider payloads. Each live keyset cursor binds group, target and limit. Deduplicate by item ID; refresh to restart. Unknown/repeated query keys are rejected. Source failures remain group-local. The full/private MCP adapter is atoll_list_context; public parity is freeze-gated under AH-3067.



## OpenAPI

````yaml /openapi.json get /api/orgs/{id}/projects/{projectId}/context
openapi: 3.1.0
info:
  title: Atoll API
  version: 1.0.0
  description: >-
    REST API for Atoll project management, agent collaboration, strategy
    tracking, and integrations.
servers:
  - url: https://atollhq.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Organizations
  - name: Projects
  - name: Project access
  - name: Issues
  - name: Issue details
  - name: Milestones
  - name: Artifacts
  - name: Strategy
  - name: Members and agents
  - name: Planning
  - name: Setup
  - name: Integrations and billing
  - name: Notifications and public
  - name: Private inbox
  - name: Agent executions
  - name: Human attention
paths:
  /api/orgs/{id}/projects/{projectId}/context:
    get:
      tags:
        - Projects
      summary: Read compact project Context
      description: >-
        Target-authorized version-1 summaries with separate authority,
        freshness, identity and explicit detail handles. Six default groups;
        Design and Discussion remain empty. No bodies, history or provider
        payloads. Each live keyset cursor binds group, target and limit.
        Deduplicate by item ID; refresh to restart. Unknown/repeated query keys
        are rejected. Source failures remain group-local. The full/private MCP
        adapter is atoll_list_context; public parity is freeze-gated under
        AH-3067.
      operationId: get_api_orgs_id_projects_projectId_context
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: group
          in: query
          schema:
            type: string
            enum:
              - development
              - design
              - discussion
              - documents
              - deployments
              - production
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 25
            default: 5
        - name: cursor
          in: query
          description: Requires the original group, target and limit.
          schema:
            type: string
            maxLength: 4096
      responses:
        '200':
          description: Compact Context envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContextIndexResponse'
        '400':
          description: invalid_context_query or invalid_context_cursor
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '413':
          description: context_response_too_large; retry with a smaller limit
        '500':
          description: context_unavailable
      security:
        - bearerAuth: []
components:
  schemas:
    ContextIndexResponse:
      type: object
      properties:
        context:
          type: object
          properties:
            schema_version:
              type: number
              enum:
                - 1
            target:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - issue
                    - project
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
              additionalProperties: false
            groups:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    enum:
                      - development
                      - design
                      - discussion
                      - documents
                      - deployments
                      - production
                  state:
                    type: string
                    enum:
                      - available
                      - empty
                      - partial
                      - unavailable
                  items:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              maxLength: 64
                            availability:
                              type: string
                              enum:
                                - available
                                - stale
                                - partial
                                - unavailable
                                - unresolved
                            freshness:
                              type: object
                              properties:
                                observed_at:
                                  type: string
                                  nullable: true
                                stale:
                                  type: boolean
                                  nullable: true
                              required:
                                - observed_at
                                - stale
                              additionalProperties: false
                            current_identity:
                              type: object
                              properties:
                                revision_id:
                                  type: string
                                  format: uuid
                                  nullable: true
                                commit_sha:
                                  type: string
                                  pattern: ^[0-9a-f]{40}$
                                  nullable: true
                              required:
                                - revision_id
                                - commit_sha
                              additionalProperties: false
                            kind:
                              type: string
                              enum:
                                - artifact
                            group:
                              type: string
                              enum:
                                - documents
                            authority:
                              type: string
                              enum:
                                - atoll_record
                            summary:
                              type: object
                              properties:
                                title:
                                  type: string
                                artifact_type:
                                  type: string
                                  enum:
                                    - prd
                                    - implementation_plan
                                    - test_plan
                                    - decision
                                    - research
                                    - release_checklist
                              required:
                                - title
                                - artifact_type
                              additionalProperties: false
                            follow_up:
                              type: object
                              properties:
                                operation:
                                  type: string
                                  enum:
                                    - artifact_revision
                                artifact_id:
                                  type: string
                                  format: uuid
                                revision_id:
                                  type: string
                                  format: uuid
                                  nullable: true
                              required:
                                - operation
                                - artifact_id
                                - revision_id
                              additionalProperties: false
                            actions:
                              type: object
                              properties:
                                can_edit:
                                  type: boolean
                                can_unlink:
                                  type: boolean
                              required:
                                - can_edit
                                - can_unlink
                              additionalProperties: false
                          required:
                            - id
                            - availability
                            - freshness
                            - current_identity
                            - kind
                            - group
                            - authority
                            - summary
                            - follow_up
                            - actions
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                              maxLength: 64
                            availability:
                              type: string
                              enum:
                                - available
                                - stale
                                - partial
                                - unavailable
                                - unresolved
                            freshness:
                              type: object
                              properties:
                                observed_at:
                                  type: string
                                  nullable: true
                                stale:
                                  type: boolean
                                  nullable: true
                              required:
                                - observed_at
                                - stale
                              additionalProperties: false
                            current_identity:
                              type: object
                              properties:
                                revision_id:
                                  type: string
                                  format: uuid
                                  nullable: true
                                commit_sha:
                                  type: string
                                  pattern: ^[0-9a-f]{40}$
                                  nullable: true
                              required:
                                - revision_id
                                - commit_sha
                              additionalProperties: false
                            kind:
                              type: string
                              enum:
                                - external_reference
                            group:
                              type: string
                              enum:
                                - development
                                - deployments
                                - production
                            authority:
                              type: string
                              enum:
                                - provider_reference
                            summary:
                              type: object
                              properties:
                                provider:
                                  type: string
                                  enum:
                                    - github
                                    - vercel
                                object_type:
                                  type: string
                                  enum:
                                    - pull_request
                                    - deployment
                                label:
                                  type: string
                                  nullable: true
                                url:
                                  type: string
                                environment:
                                  type: string
                                  enum:
                                    - preview
                                    - staging
                                    - production
                                  nullable: true
                                state:
                                  type: string
                                  enum:
                                    - queued
                                    - building
                                    - ready
                                    - failed
                                    - cancelled
                                    - superseded
                                  nullable: true
                                provider_effective_at:
                                  type: string
                                  nullable: true
                              required:
                                - provider
                                - object_type
                                - label
                                - url
                                - environment
                                - state
                                - provider_effective_at
                              additionalProperties: false
                            follow_up:
                              type: object
                              properties:
                                operation:
                                  type: string
                                  enum:
                                    - external_reference
                                reference_id:
                                  type: string
                                  format: uuid
                              required:
                                - operation
                                - reference_id
                              additionalProperties: false
                            actions:
                              type: object
                              properties:
                                can_unlink:
                                  type: boolean
                              required:
                                - can_unlink
                              additionalProperties: false
                          required:
                            - id
                            - availability
                            - freshness
                            - current_identity
                            - kind
                            - group
                            - authority
                            - summary
                            - follow_up
                            - actions
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                              maxLength: 64
                            availability:
                              type: string
                              enum:
                                - available
                                - stale
                                - partial
                                - unavailable
                                - unresolved
                            freshness:
                              type: object
                              properties:
                                observed_at:
                                  type: string
                                  nullable: true
                                stale:
                                  type: boolean
                                  nullable: true
                              required:
                                - observed_at
                                - stale
                              additionalProperties: false
                            current_identity:
                              type: object
                              properties:
                                revision_id:
                                  type: string
                                  format: uuid
                                  nullable: true
                                commit_sha:
                                  type: string
                                  pattern: ^[0-9a-f]{40}$
                                  nullable: true
                              required:
                                - revision_id
                                - commit_sha
                              additionalProperties: false
                            kind:
                              type: string
                              enum:
                                - operational_evidence
                            group:
                              type: string
                              enum:
                                - development
                            authority:
                              type: string
                              enum:
                                - operational_evidence
                            summary:
                              type: object
                              properties:
                                pr_number:
                                  type: integer
                                  exclusiveMinimum: true
                                  minimum: 0
                                pr_state:
                                  type: string
                                  enum:
                                    - open
                                    - closed
                                    - merged
                                review:
                                  type: string
                                  enum:
                                    - pending
                                    - approved
                                    - changes_requested
                                    - unknown
                                workflows:
                                  type: string
                                  enum:
                                    - none
                                    - pending
                                    - passed
                                    - failed
                                    - cancelled
                                    - unknown
                                required_checks:
                                  type: string
                                  enum:
                                    - none
                                    - pending
                                    - passed
                                    - failed
                                    - cancelled
                                    - unknown
                                blocker:
                                  type: string
                                  enum:
                                    - head_unknown
                                    - pull_request_closed
                                    - changes_requested
                                    - required_checks_failed
                                    - required_checks_cancelled
                                    - required_checks_pending
                                    - required_checks_unknown
                                    - workflows_failed
                                    - workflows_cancelled
                                    - workflows_pending
                                    - review_pending
                                  nullable: true
                              required:
                                - pr_number
                                - pr_state
                                - review
                                - workflows
                                - required_checks
                                - blocker
                              additionalProperties: false
                            follow_up:
                              type: object
                              properties:
                                operation:
                                  type: string
                                  enum:
                                    - issue_delivery_context
                                issue_id:
                                  type: string
                                  format: uuid
                              required:
                                - operation
                                - issue_id
                              additionalProperties: false
                            actions:
                              type: object
                              properties:
                                can_expand:
                                  type: boolean
                                  enum:
                                    - true
                              required:
                                - can_expand
                              additionalProperties: false
                          required:
                            - id
                            - availability
                            - freshness
                            - current_identity
                            - kind
                            - group
                            - authority
                            - summary
                            - follow_up
                            - actions
                          additionalProperties: false
                    maxItems: 25
                  page:
                    type: object
                    properties:
                      limit:
                        type: integer
                        minimum: 1
                        maximum: 25
                      returned_count:
                        type: integer
                        minimum: 0
                        maximum: 25
                      has_more:
                        type: boolean
                      next_cursor:
                        type: string
                        maxLength: 4096
                        nullable: true
                    required:
                      - limit
                      - returned_count
                      - has_more
                      - next_cursor
                    additionalProperties: false
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        source:
                          type: string
                          enum:
                            - artifacts
                            - references
                            - delivery
                        code:
                          type: string
                          enum:
                            - source_unavailable
                            - invalid_source
                            - incomplete_evidence
                      required:
                        - source
                        - code
                      additionalProperties: false
                    maxItems: 3
                required:
                  - key
                  - state
                  - items
                  - page
                  - errors
                additionalProperties: false
              maxItems: 6
            partial:
              type: boolean
          required:
            - schema_version
            - target
            - groups
            - partial
          additionalProperties: false
      required:
        - context
      additionalProperties: false
    Error:
      type: object
      description: >-
        Common error responses contain error. Shared missing-auth and
        unknown-API responses also contain a stable code.
      properties:
        error:
          type: string
        code:
          type: string
      required:
        - error
      examples:
        - error: Unauthorized
          code: unauthorized
        - error: Not found
          code: not_found
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated but not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found or not visible
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_atoll_<key>

````

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