---
title: "Get Campaign Block Snippet Assignments"
method: GET
path: "/v2/campaigns/{campaignId}/block-snippets"
tags: ["Campaigns.Block Snippets"]
---

# Get Campaign Block Snippet Assignments

`GET /v2/campaigns/{campaignId}/block-snippets`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/campaigns/{campaignId}/block-snippets`
- Auth: API key in header `x-api-key`

See which snippet is assigned to each prompt block in a campaign.

## Path parameters

- `campaignId` string, uuid, required: Campaign ID

## Response `200`

GET /v2/campaigns/:campaignId/block-snippets Positive response

- GetV2CampaignsCampaignIdBlockSnippetsPositiveResponse
  - `assignments` object[], required
    - `id` string, uuid, required
    - `createdAt` string, date-time, nullable, required: Campaign block assignment creation time. ISO 8601 timestamp
    - `campaignId` string, uuid, required
    - `behaviorKey` string, uuid, nullable, required
    - `blockId` string, uuid, nullable, required
    - `snippetId` string, uuid, nullable, required
    - `transferConfigId` string, uuid, nullable, required
    - `appointmentConfigId` string, uuid, nullable, required
    - `capabilityId` string, uuid, nullable, required
    - `scope` 'business_hours' | 'after_hours', required
    - `appliesTo` union, required
      - string
      - number
      - boolean
      - object
      - unknown[]
        - unknown
    - `enabled` boolean, required
    - `priority` integer, required
    - `isDefault` boolean, required
    - `settings` union, required
      - string
      - number
      - boolean
      - object
      - unknown[]
        - unknown
    - `block` object, nullable, required
      - `id` string, uuid, required
      - `createdAt` string, date-time, nullable, required: Prompt block creation time. ISO 8601 timestamp
      - `updatedAt` string, date-time, nullable, required: Prompt block last update time. ISO 8601 timestamp
      - `name` string, required
      - `tag` string, required
      - `description` string, nullable, required
      - `toolType` string, required
      - `enabled` boolean, required
      - `kind` 'tool' | 'context' | 'memory', required
      - `contract` union, required
        - string
        - number
        - boolean
        - object
        - unknown[]
          - unknown
      - `injectionTag` string, nullable, required
    - `snippet` object, required
      - `id` string, uuid, required
      - `createdAt` string, date-time, nullable, required: Prompt snippet creation time. ISO 8601 timestamp
      - `updatedAt` string, date-time, nullable, required: Prompt snippet last update time. ISO 8601 timestamp
      - `clientId` string, uuid, nullable, required
      - `name` string, required
      - `description` string, nullable, required
      - `examples` string, nullable, required
      - `toolsAllowlist` union, required
        - string
        - number
        - boolean
        - object
        - unknown[]
          - unknown
      - `verticalAllowlist` union, required
        - string
        - number
        - boolean
        - object
        - unknown[]
          - unknown
      - `isSystem` boolean, required
      - `enabled` boolean, required
    - `transferConfig` object, nullable
      - `id` string, uuid, required
      - `createdAt` string, date-time, nullable, required: Transfer config creation time. ISO 8601 timestamp
      - `updatedAt` string, date-time, nullable, required: Transfer config last update time. ISO 8601 timestamp
      - `clientId` string, uuid, nullable, required
      - `name` string, nullable, required
      - `routingConfigId` string, uuid, nullable, required
      - `configuration` object, required
        - `version` 2, required
        - `destination` union, required
          - object
            - `type` 'direct', required
            - `phoneNumber` string, nullable, required
            - `externalHandoff` object, required
              - …
          - object
            - `type` 'dynamic', required
            - `pingUrl` string
            - `method` 'GET' | 'POST'
            - `timeout` integer
            - `headers` object
            - `body` object
            - `transferNumberField` string
            - `transferNumber` string
            - `successConditions` object[]
              - …
            - `fallback` union, required
              - …
            - `externalHandoff` object, required
              - …
          - object
            - `type` 'sip', required
            - `uri` string, nullable, required
            - `headers` object, required
            - `externalHandoff` object, required
              - …
          - object
            - `type` 'softphone', required
            - `routingConfigId` string, uuid, nullable, required
            - `handoffStrategy` 'wait-for-operator' | 'immediate-transfer', required
            - `voiceAiFallback` union, required
              - …
            - `agentWorkspace` object, required
              - …
            - `agentFirstHandling` object, required
              - …
        - `drafts` object, required
          - `direct` object
            - `type` 'direct', required
            - `phoneNumber` string, nullable, required
            - `externalHandoff` object, required
              - …
          - `dynamic` object
            - `type` 'dynamic', required
            - `pingUrl` string
            - `method` 'GET' | 'POST'
            - `timeout` integer
            - `headers` object
            - `body` object
            - `transferNumberField` string
            - `transferNumber` string
            - `successConditions` object[]
              - …
            - `fallback` union, required
              - …
            - `externalHandoff` object, required
              - …
          - `sip` object
            - `type` 'sip', required
            - `uri` string, nullable, required
            - `headers` object, required
            - `externalHandoff` object, required
              - …
          - `softphone` object
            - `type` 'softphone', required
            - `routingConfigId` string, uuid, nullable, required
            - `handoffStrategy` 'wait-for-operator' | 'immediate-transfer', required
            - `voiceAiFallback` union, required
              - …
            - `agentWorkspace` object, required
              - …
            - `agentFirstHandling` object, required
              - …
        - `warmTransfer` object, required
          - `mode` 'wait-for-operator' | 'immediate-summary', required
          - `summaryPrompt` string, nullable, required
      - `appointmentConfigId` string, uuid, nullable, required
      - `callFormId` string, uuid, nullable, required
    - `appointmentConfig` object, nullable
      - `id` string, uuid, required
      - `createdAt` string, date-time, nullable, required: Appointment config creation time. ISO 8601 timestamp
      - `updatedAt` string, date-time, nullable, required: Appointment config last update time. ISO 8601 timestamp
      - `clientId` string, uuid, nullable, required
      - `name` string, nullable, required
      - `description` string, nullable, required
      - `concurrentLimit` integer, required
      - `appointmentLength` integer, required
      - `appointmentSpacing` integer, required
      - `maxOptions` integer, required
      - `minDate` string, date, nullable, required: Earliest appointment date. Canonical format: YYYY-MM-DD
      - `maxDate` string, date, nullable, required: Latest appointment date. Canonical format: YYYY-MM-DD
      - `minHours` integer, nullable, required
      - `preferredMode` 'timezone' | 'zipcode', required
      - `appointmentMode` 'phone_call' | 'in_person' | 'video_call' | 'agent_phone_call', required
      - `showCallerIdOnBookingPage` boolean, required
      - `assignmentMode` 'customer_agent' | 'routing_config' | 'external_transfer', required
      - `routingConfigId` string, uuid, nullable, required
      - `transferConfigId` string, uuid, nullable, required
      - `workflows` union, required
        - string
        - number
        - boolean
        - object
        - unknown[]
          - unknown
      - `bookingHours` union, required
        - string
        - number
        - boolean
        - object
        - unknown[]
          - unknown
      - `createdBy` string, uuid, nullable, required
      - `updatedBy` string, uuid, nullable, required
  - `total` number, required

## Other responses

- `400`: GET /v2/campaigns/:campaignId/block-snippets Negative response 400
- `401`: GET /v2/campaigns/:campaignId/block-snippets Negative response 401
- `403`: GET /v2/campaigns/:campaignId/block-snippets Negative response 403
- `404`: GET /v2/campaigns/:campaignId/block-snippets Negative response 404
- `409`: GET /v2/campaigns/:campaignId/block-snippets Negative response 409
- `422`: GET /v2/campaigns/:campaignId/block-snippets Negative response 422
- `429`: GET /v2/campaigns/:campaignId/block-snippets Negative response 429
- `500`: GET /v2/campaigns/:campaignId/block-snippets Negative response 500
- `502`: GET /v2/campaigns/:campaignId/block-snippets Negative response 502
- `503`: GET /v2/campaigns/:campaignId/block-snippets Negative response 503

---

[API](https://skmtc.dev/carecycle/apis/carecycle-public-api.md) - [All operations](https://skmtc.dev/carecycle/apis/carecycle-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carecycle/apis/carecycle-public-api/revisions/db390c743c36?raw)