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

# Retrieve an outcome form

> Requires the `agent:read` scope.

`meeting` as the id is the built-in Book a meeting.



## OpenAPI

````yaml /api-reference/openapi.json get /outcomes/{id}
openapi: 3.1.0
info:
  title: Darwin API
  version: '2026-10-12'
  description: >-
    Read and act on your Darwin workspace: conversations, contacts, meetings,
    outcome forms and their requests, personal links and their greetings,
    analytics, knowledge, the agent, its chat buttons and its opening tests,
    with signed webhooks for what happens.


    Authenticate with a secret key from Integrations → API: `Authorization:
    Bearer dk_live_…`. Keys carry scopes; personal data needs `contacts:read`.

    Rate limits are per key per minute: origin 120, adapt 120, evolve 600, apex
    1200; heavy calls (exports, crawls, model work) have a smaller budget. Every
    response carries RateLimit-* headers.

    Lists are cursor-paginated (`limit`, `starting_after`, `next_cursor`).
    Writes accept `Idempotency-Key`. Errors are RFC 9457 problem documents with
    a stable `code` and a `request_id`.
  contact:
    name: Darwin
    url: https://docs.meetdarwin.ai/api-reference/introduction
servers:
  - url: https://api.meetdarwin.ai/v1
security:
  - bearer: []
tags:
  - name: Workspace
  - name: Conversations
  - name: Contacts
  - name: Meetings
  - name: Outcomes
  - name: Personal links
  - name: Analytics
  - name: Events
  - name: Webhooks
  - name: Knowledge
  - name: Agent
  - name: Experiments
  - name: Privacy
  - name: Chat
paths:
  /outcomes/{id}:
    get:
      tags:
        - Outcomes
      summary: Retrieve an outcome form
      description: |-
        Requires the `agent:read` scope.

        `meeting` as the id is the built-in Book a meeting.
      operationId: getOutcome
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Outcome'
        '400':
          description: Invalid request (`invalid_request`, `unsupported_version`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: >-
            Missing or invalid key (`authentication_required`,
            `invalid_api_key`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '402':
          description: >-
            The workspace must add a card before the API can be used
            (`payment_required`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: The key lacks the scope (`insufficient_scope`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: No such object in this workspace (`not_found`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: >-
            Conflicts with the current state (`conflict`,
            `idempotency_key_in_use`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Refused by a rule (`unprocessable`, `idempotency_key_reused`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            Rate limited (`rate_limited`) or a monthly allowance used
            (`quota_exceeded`); see Retry-After.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
components:
  schemas:
    Outcome:
      type: object
      properties:
        id:
          type: string
          example: out_hnuk3nnp4kwt7hlb
          description: >-
            out_…, or `meeting` for Book a meeting before it has been saved with
            questions.
        object:
          type: string
          const: outcome
        kind:
          type: string
          enum:
            - form
            - meeting
          description: >-
            meeting: the built-in Book a meeting, whose questions come before
            the calendar. form: a form you built.
        name:
          type: string
        status:
          type: string
          enum:
            - live
            - draft
          description: >-
            live: the agent offers it. Book a meeting is live while it has
            questions.
        button_label:
          type: string
          description: >-
            The button the agent shows above the message box when it offers the
            form.
        offer_when:
          type: string
          description: 'When the agent opens it: "Offer it when the visitor…".'
        then:
          type: string
          enum:
            - message
            - meeting
        meeting_optional:
          type: boolean
        required_before_booking:
          type: boolean
        questions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: >-
                  Stable while the question exists; send it back when you edit
                  the question.
              key:
                type: string
                description: >-
                  The answer's key in requests, made from the question's words
                  (it changes if they change).
              question:
                type: string
              type:
                type: string
              required:
                type: boolean
              agent_can_fill:
                type: boolean
              choices:
                anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
              unit:
                type:
                  - string
                  - 'null'
              not_a_fit:
                type: array
                items:
                  type: string
              min:
                type:
                  - number
                  - 'null'
              max:
                type:
                  - number
                  - 'null'
            required:
              - id
              - key
              - question
              - type
              - required
              - agent_can_fill
              - choices
              - unit
              - not_a_fit
              - min
              - max
        phone:
          type: string
          enum:
            - 'off'
            - optional
            - required
        done_message:
          type: string
        not_fit_message:
          type: string
        notify:
          type: array
          items:
            type: string
        top_of_chat:
          type: boolean
        results:
          type: object
          properties:
            days:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            started:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            sent:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            not_fit:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - days
            - started
            - sent
            - not_fit
          description: >-
            The last 30 days: forms the agent opened, requests sent, and sent
            requests that were not a fit. Preview chats are left out.
        version:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        updated_at:
          anyOf:
            - type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
            - type: 'null'
      required:
        - id
        - object
        - kind
        - name
        - status
        - button_label
        - offer_when
        - then
        - meeting_optional
        - required_before_booking
        - questions
        - phone
        - done_message
        - not_fit_message
        - notify
        - top_of_chat
        - results
        - version
        - updated_at
    Problem:
      type: object
      properties:
        type:
          type: string
          example: https://docs.meetdarwin.ai/api-reference/errors#insufficient_scope
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        code:
          type: string
          example: insufficient_scope
        detail:
          type: string
        param:
          type: string
        request_id:
          type: string
          example: req_8m2k4p0q1x7z9c3v5b6n
      required:
        - type
        - title
        - status
        - code
        - detail
        - request_id
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        A secret key (dk_live_…). Scopes: conversations:read, contacts:read,
        contacts:write, meetings:read, analytics:read, events:read,
        webhooks:write, knowledge:read, knowledge:write, agent:read,
        agent:write, experiments:read, experiments:write, privacy:write,
        chat:write.

````

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