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

# Read a campaign's personalized lines (written for each person): their {{keys}} for steps, instructions and fallbacks, how many people have them, and the cost per person

> Read a campaign's personalized lines (written for each person): their {{keys}} for steps, instructions and fallbacks, how many people have them, and the cost per person.



## OpenAPI

````yaml /api-reference/openapi.json get /campaigns/{sequenceId}/personalization
openapi: 3.1.0
info:
  title: Dench API
  version: 1.0.0
  description: >-
    Versioned Dench workspace API. The operation registry is shared with the
    Dench CLI parity layer, so every CLI command maps to an endpoint here.
servers:
  - url: https://www.dench.com/api/v1
security: []
tags:
  - name: agent-config
    description: Agent Config operations.
  - name: approvals
    description: Approvals operations.
  - name: apps
    description: Apps operations.
  - name: auth
    description: Auth operations.
  - name: billing
    description: Billing operations.
  - name: browser
    description: Browser operations.
  - name: campaigns
    description: Campaigns operations.
  - name: chat
    description: Chat operations.
  - name: crm
    description: Crm operations.
  - name: email
    description: Email operations.
  - name: files
    description: Files operations.
  - name: gateway
    description: Gateway operations.
  - name: lists
    description: Lists operations.
  - name: local
    description: Local operations.
  - name: meetings
    description: Meetings operations.
  - name: members
    description: Members operations.
  - name: memory
    description: Memory operations.
  - name: meta
    description: Meta operations.
  - name: notifications
    description: Notifications operations.
  - name: routines
    description: Routines operations.
  - name: settings
    description: Settings operations.
  - name: workspace
    description: Workspace operations.
paths:
  /campaigns/{sequenceId}/personalization:
    get:
      tags:
        - campaigns
      summary: >-
        Read a campaign's personalized lines (written for each person): their
        {{keys}} for steps, instructions and fallbacks, how many people have
        them, and the cost per person
      description: >-
        Read a campaign's personalized lines (written for each person): their
        {{keys}} for steps, instructions and fallbacks, how many people have
        them, and the cost per person.
      operationId: campaigns_personalization_get
      parameters:
        - name: sequenceId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  template:
                    anyOf:
                      - type: object
                        properties:
                          variables:
                            minItems: 1
                            maxItems: 5
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: string
                                  description: >-
                                    The {{key}} used in steps: a letter, then
                                    letters, digits or _ (up to 40). Not a
                                    built-in field like firstName or company.
                                label:
                                  type: string
                                  description: The line's name, up to 60 characters.
                                prompt:
                                  type: string
                                  description: >-
                                    What the writer should say, up to 600
                                    characters.
                                fallback:
                                  type: string
                                  description: >-
                                    Sent when there is nothing specific to say;
                                    up to 300 characters, no {{variables}}.
                                fallbackFrom:
                                  description: >-
                                    A field to use before the fallback, e.g.
                                    Company.
                                  type: string
                                maxChars:
                                  description: The longest line, default 200 characters.
                                  type: integer
                                  minimum: 20
                                  maximum: 300
                              required:
                                - key
                                - label
                                - prompt
                                - fallback
                              additionalProperties: false
                              description: One personalized line.
                          context:
                            type: object
                            properties:
                              sells:
                                type: string
                                description: What you sell, up to 1000 characters.
                              offer:
                                description: >-
                                  The offer or call to action, up to 300
                                  characters.
                                type: string
                            required:
                              - sells
                            additionalProperties: false
                          version:
                            type: number
                          updatedAt:
                            type: number
                        required:
                          - variables
                          - context
                          - version
                          - updatedAt
                        additionalProperties: {}
                      - type: 'null'
                  counts:
                    type: object
                    properties:
                      done:
                        type: number
                      pending:
                        type: number
                      failed:
                        type: number
                      total:
                        type: number
                    required:
                      - done
                      - pending
                      - failed
                      - total
                    additionalProperties: false
                  paused:
                    type: boolean
                  notice:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            const: insufficient_credits
                          at:
                            type: number
                        required:
                          - code
                          - at
                        additionalProperties: false
                      - type: 'null'
                  suggestedContext:
                    type: object
                    properties:
                      sells:
                        type: string
                    additionalProperties: false
                  estimatedCentsPerPerson:
                    type: number
                  eligible:
                    type: number
                required:
                  - template
                  - counts
                  - paused
                  - notice
                  - suggestedContext
                  - estimatedCentsPerPerson
                  - eligible
                additionalProperties: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - DenchApiKey: []
        - AgentSession: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Operation or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
            details: {}
  securitySchemes:
    DenchApiKey:
      type: http
      scheme: bearer
      bearerFormat: DENCH_API_KEY
      description: >-
        Workspace-scoped Dench API key from workspace settings. This is the same
        key used by DENCH_API_KEY in sandboxes.
    AgentSession:
      type: http
      scheme: bearer
      bearerFormat: dch_agent_*
      description: >-
        Agent session token created by `dench signin`. Gateway-backed routes
        exchange this token for the workspace gateway key.

````

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