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

# Read goal key results

> Reads key results for a goal.



## OpenAPI

````yaml /openapi.v1.local.json get /v1/public/goals/{id}/key-results
openapi: 3.0.3
info:
  title: Agile Tools Public API
  description: >-
    REST API for integrating external systems with Agile Tools.


    ## Authentication


    Most endpoints require an `X-API-Key` header containing a valid owner-typed
    API key. Supported ownership types are `ORGANIZATION`, `PERSON`, and
    `VALUE_UNIT`. Anonymous library browsing endpoints use short-lived session
    tokens instead.


    ## Scope Behavior


    Wildcard scope (`*`) is organization-only. Value-unit keys are restricted to
    value-unit-centric endpoint families and descendant scope checks. Personal
    keys default to personal-empty scope unless explicit permissions are
    granted. Cross-organization key governance is out of scope for
    `/v1/public/*` and is handled by `/v1/sys/public-api-keys`.


    ## Rate Limiting


    Requests are rate-limited per API key based on your subscription plan. When
    a limit is exceeded the API returns `429 Too Many Requests` with a
    `Retry-After` header.


    ## Idempotency


    POST and PUT requests support idempotent replay via the optional
    `Idempotency-Key` header. Selected high-risk KPI and Health Metric write
    endpoints require this header to ensure safe retries without duplicate
    side-effects.


    ## Response Envelope


    Public v1 and v2 response contracts coexist during migration. Authenticated
    public endpoints use `PublicApiKeyMeta` semantics (`requestId`, `timestamp`)
    and anonymous public endpoints use `PublicAnonymousMeta` semantics.
    Anonymous library endpoints may add `PublicAnonymousLibraryMeta` tab-count
    metadata while authenticated public endpoints do not define a library
    tab-count metadata branch.


    ## Public Docs Visibility Policy


    Published public docs intentionally exclude anonymous Sessions and Library
    endpoints. Those v1 anonymous flows remain runtime-stable but are not listed
    in Mintlify-facing OpenAPI output.


    ## Migration Guidance


    For list endpoints, migrate in stages: keep v1 stable, adopt v2 offset mode
    first, then adopt v2 cursor mode where needed. Fallback expectation: clients
    may continue using v1 while v2 adoption is rolled out incrementally.


    ## Versioning & Deprecation Policy


    Breaking changes require a new major version (`/v2/`). Non-breaking
    additions ship in the current version. Deprecated endpoints include a
    `Sunset` HTTP header with the removal date. Minimum notice period: 6 months.
  contact:
    name: Agile Tools Developer Support
    url: https://teampoolz.mintlify.app
    email: dev-support@agile-tools.io
  version: 1.0.0
servers:
  - url: https://api.agile-tools.io
    description: Production
  - url: https://api.alpha.agile-tools.io
    description: Staging
  - url: https://free-trusty-kit.ngrok-free.app
    description: Local Development
security: []
tags:
  - name: Address
  - name: Audit
  - name: Auth
  - name: Available scope
  - name: Billing Role
  - name: Billing Role Rate
  - name: Billing Role Rates
  - name: Billing Roles
  - name: Board
  - name: Budget
  - name: Budgets
  - name: Check In
  - name: Client
  - name: Client Project
  - name: Contact Info
  - name: Country
  - name: Demo Management
  - name: Goal
  - name: Goal Template
  - name: Goals
  - name: Group Notification Preferences
  - name: Groups
    description: Operations related to user groups
  - name: Health Metrics
  - name: Holiday Schemes
  - name: Hrosc
  - name: ISCO Groups
  - name: Integrations
  - name: Janitor System
  - name: Job Positions
  - name: KPIs
  - name: Key Result
  - name: Key Result Template
  - name: Key Results
  - name: Library Admin
  - name: Library Export
  - name: Library Import
  - name: Manager
  - name: Metric Period
  - name: Metric Template
  - name: Milestone
  - name: Nav Info
  - name: Newsletter
  - name: Notification Preferences
  - name: Observed Metrics
  - name: Org Account
  - name: Organizational Unit
  - name: Organizational Units
  - name: People
  - name: Person
  - name: Person Job Positions
  - name: Person Rate
  - name: Person Rates
  - name: Person Skills
  - name: Preferences
  - name: Public API Keys
  - name: Registration
  - name: SCM Repositories
  - name: Skills
  - name: Strategic Concept
  - name: Strategy
  - name: Stripe
  - name: Subscription
  - name: Sys Billing Role Rates
  - name: Sys Billing Roles
  - name: Sys Budgets
  - name: Sys Catalog
  - name: Sys Catalog Skill Groups
  - name: Sys Catalog Sync
  - name: Sys Check Ins
  - name: Sys Goals
  - name: Sys Job Positions
  - name: Sys Key Results
  - name: Sys Organizational Units
  - name: Sys Person
  - name: Sys Person Job Positions
  - name: Sys Person Rates
  - name: Sys Person Skills
  - name: Sys Public API Keys
  - name: Sys Skills
  - name: Sys Tags
  - name: Sys Teams
  - name: Sys Value Items
  - name: Sys Value Units
  - name: Tag
  - name: Tags
  - name: Team
  - name: Teams
  - name: Time zones
  - name: Timesheet
  - name: Timesheet Export
  - name: Timesheet Period Configuration
  - name: Timesheet Period Management
  - name: Timesheet Periods
  - name: Unit
  - name: Value Item
  - name: Value Item Settings
  - name: Value Items
  - name: Value Unit
  - name: Value Units
  - name: Webhooks
  - name: Workboards
  - name: Workflow
  - name: Workload Schemes
  - name: Worklog Approvals Configuration
  - name: Worklog Conflicts
  - name: Worklog Scheduler Configuration
  - name: Worklogs
paths:
  /v1/public/goals/{id}/key-results:
    get:
      tags:
        - Goals
      summary: Read goal key results
      description: Reads key results for a goal.
      operationId: readPublicGoalKeyResults
      parameters:
        - name: id
          in: path
          required: true
          schema:
            pattern: '[^\s_]\S*'
            type: string
        - name: lastPeriodCount
          in: query
          schema:
            format: int32
            maximum: 12
            type: integer
      responses:
        '200':
          description: Key results returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicKeyResultDto'
              examples:
                goal key result list:
                  value:
                    data:
                      - id: 5cf89d34-ef03-4d5a-b40e-05295a88ec4d
                        status: ACTIVE
                        modificationStatus: NOT_MODIFIED
                        name: Reduce incident MTTR
                        context: Improve incident response speed
                    meta:
                      requestId: 170a6584-6d89-4c95-a2ff-22378cb6355d
                      timestamp: '2026-04-22T12:00:00Z'
      security:
        - apiKey: []
components:
  schemas:
    PublicKeyResultDto:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: '#/components/schemas/KeyResultStatus'
        modificationStatus:
          $ref: '#/components/schemas/ModificationStatus'
        currentPeriod:
          $ref: '#/components/schemas/PublicKeyResultPeriodSummaryDto'
        confidence:
          $ref: '#/components/schemas/KeyResultConfidence'
        confidenceSource:
          $ref: '#/components/schemas/KeyResultConfidenceSource'
        checkInStats:
          $ref: '#/components/schemas/PublicKeyResultCheckInStatsDto'
        clonedFrom:
          $ref: '#/components/schemas/PublicIdReferenceDto'
        goal:
          $ref: '#/components/schemas/PublicNamedReferenceDto'
        name:
          type: string
        context:
          type: string
        steps:
          type: array
          items:
            $ref: '#/components/schemas/PublicKeyResultStepDto'
        percentageItems:
          format: int32
          type: integer
        latestNote:
          $ref: '#/components/schemas/PublicKeyResultNoteDto'
    KeyResultStatus:
      enum:
        - DRAFT
        - PUBLISHED
        - ACTIVE
        - ABANDONED
        - COMPLETED
      type: string
    ModificationStatus:
      enum:
        - NOT_MODIFIED
        - PENDING
        - MODIFIED
      type: string
    PublicKeyResultPeriodSummaryDto:
      type: object
      properties:
        id:
          type: string
        keyResult:
          $ref: '#/components/schemas/PublicIdReferenceDto'
        metricPeriod:
          $ref: '#/components/schemas/PublicIdReferenceDto'
        confidence:
          $ref: '#/components/schemas/KeyResultConfidence'
        checkedSteps:
          type: array
          items:
            $ref: '#/components/schemas/PublicIdReferenceDto'
        period:
          $ref: '#/components/schemas/PublicKeyResultCheckInPeriodDto'
        value:
          type: number
    KeyResultConfidence:
      enum:
        - LOW
        - MEDIUM
        - HIGH
      type: string
    KeyResultConfidenceSource:
      enum:
        - IMPLICIT
        - CHECK_IN
      type: string
    PublicKeyResultCheckInStatsDto:
      type: object
      properties:
        firstStart:
          $ref: '#/components/schemas/LocalDate'
        lastEnd:
          $ref: '#/components/schemas/LocalDate'
        hasCheckIns:
          type: boolean
    PublicIdReferenceDto:
      type: object
      properties:
        id:
          type: string
    PublicNamedReferenceDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    PublicKeyResultStepDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        percentage:
          type: number
    PublicKeyResultNoteDto:
      type: object
      properties:
        id:
          type: string
        message:
          type: string
        author:
          $ref: '#/components/schemas/PublicNamedReferenceDto'
        creationTimestamp:
          $ref: '#/components/schemas/Instant'
        updateTimestamp:
          $ref: '#/components/schemas/Instant'
    PublicKeyResultCheckInPeriodDto:
      required:
        - type
        - startsAt
        - endsAt
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PeriodType'
        startsAt:
          $ref: '#/components/schemas/LocalDate'
        endsAt:
          $ref: '#/components/schemas/LocalDate'
    LocalDate:
      format: date
      type: string
      example: '2022-03-10'
    Instant:
      format: date-time
      type: string
      example: '2022-03-10T16:15:50Z'
    PeriodType:
      enum:
        - DAY
        - MONTH
        - QUARTER
        - FOUR_MONTHS
        - SIX_MONTHS
        - YEAR
        - TWO_YEARS
        - THREE_YEARS
        - FIVE_YEARS
        - CUSTOM
      type: string
  securitySchemes:
    apiKey:
      type: apiKey
      description: >-
        Owner-typed API key (`ORGANIZATION`, `PERSON`, `VALUE_UNIT`). Manage
        org-scoped lifecycle with `/v1/public-api-keys`; cross-org governance is
        restricted to `/v1/sys/public-api-keys`.
      name: X-API-Key
      in: header

````

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