> ## 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.

# List greetings

> Requires the `agent:read` scope.

What the chat says first and to whom: one-page greetings, audience greetings, personal link greetings and the website default (the catch-all). A live greeting comes before a page's opening. Archived greetings are listed last.



## OpenAPI

````yaml /api-reference/openapi.json get /greetings
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, the same on every plan: 600; heavy calls
    (exports, crawls, model work) have a smaller budget (30). Plans from before
    credits keep theirs. An Agency's client workspaces have the Agency's. Every
    response carries RateLimit-* headers.

    The chat API is on every plan: 2,500 conversations a month per workspace.

    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: Greetings
  - name: Personal links
  - name: Analytics
  - name: Events
  - name: Webhooks
  - name: Knowledge
  - name: Agent
  - name: Experiments
  - name: Privacy
  - name: Chat
paths:
  /greetings:
    get:
      tags:
        - Greetings
      summary: List greetings
      description: >-
        Requires the `agent:read` scope.


        What the chat says first and to whom: one-page greetings, audience
        greetings, personal link greetings and the website default (the
        catch-all). A live greeting comes before a page's opening. Archived
        greetings are listed last.
      operationId: listGreetings
      parameters:
        - name: type
          in: query
          required: false
          description: page, audience, link or default.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: live, draft, paused or archived.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - data
                  - has_more
                  - next_cursor
                properties:
                  object:
                    const: list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Greeting'
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
        '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`), the feature is off
            (`feature_disabled`), or the workspace's plan doesn't include it
            (`plan_required`, with `required_plan`).
          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`), or the change would leave a live agent
            with no calendar or live form (`goal_required`).
          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:
    Greeting:
      type: object
      properties:
        id:
          type: string
          pattern: ^gr_
          example: gr_yjh2jw
        object:
          type: string
          const: greeting
        type:
          type: string
          enum:
            - page
            - audience
            - link
            - default
          description: >-
            page: one page. audience: visitors who match show_to. link: people
            who open its personal links. default: everyone else (the catch-all),
            one per workspace.
        name:
          type: string
        text:
          type: string
          description: What the chat says first.
          example: >-
            Comparing plans? Give me a rough count of meetings a month and I'll
            find your cheapest fit.
        buttons:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              message:
                type: string
            required:
              - label
              - message
          description: >-
            Reply buttons. Your locked buttons (Agent Studio) are added when it
            is shown.
        agent_note:
          description: What the agent is told about people shown this greeting.
          type:
            - string
            - 'null'
        outcome:
          description: >-
            What it steers toward: "meeting" or an outcome form (out_…). Null:
            the chat's usual.
          type:
            - string
            - 'null'
        page:
          description: 'For type page: the page it shows on.'
          type:
            - string
            - 'null'
        links:
          type: array
          items:
            type: string
          description: 'For type link: the personal links (lk_…) that open with it.'
        show_to:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                description: >-
                  page, page_type, campaign, source, medium, content, referrer,
                  visitor, device or country.
              op:
                type: string
                description: >-
                  any_of, none_of, starts_with, contains, ends_with, is_set or
                  not_set.
              values:
                type: array
                items:
                  type: string
            required:
              - field
              - op
              - values
          description: 'For type audience: the filters a visit must all match.'
        audience:
          type: string
          description: Who sees it, in words.
          example: Page is any of /pricing
        stays:
          type: string
          enum:
            - match
            - visit
            - return
          description: >-
            match: only on pages it matches. visit: the rest of the visit.
            return: every visit for 90 days.
        status:
          type: string
          enum:
            - live
            - draft
            - paused
            - archived
        testing:
          type: string
          enum:
            - auto
            - 'off'
          description: >-
            auto: Darwin may test new openings on it (one-page greetings and the
            default). off: it keeps these words.
        position:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Order among greetings of the same kind, lowest first.
        created_by_darwin:
          type: boolean
        test:
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                name:
                  type: string
                status:
                  type: string
                unit:
                  type: string
              required:
                - id
                - name
                - status
                - unit
            - type: 'null'
          description: >-
            The test running on it now (exp_…); read it with GET
            /experiments/{id}.
        created_at:
          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)))$
        updated_at:
          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)))$
      required:
        - id
        - object
        - type
        - name
        - text
        - buttons
        - agent_note
        - outcome
        - page
        - links
        - show_to
        - audience
        - stays
        - status
        - testing
        - position
        - created_by_darwin
        - test
        - created_at
        - 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
        required_plan:
          description: >-
            With `plan_required`: the plan that unlocks what was refused.
            Upgrade under Billing in the Darwin admin.
          type: string
          enum:
            - growth
            - agency
        feature:
          description: >-
            With `plan_required`: the plan feature that was refused, such as
            `fit_rules`.
          example: fit_rules
          type:
            - string
            - 'null'
        upgrade_url:
          description: >-
            With `plan_required`: the Billing page in the Darwin admin where an
            owner upgrades.
          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.