---
title: "Get Available Snippets for Campaign"
method: GET
path: "/v2/campaigns/{campaignId}/available-snippets"
tags: ["Campaigns.Block Snippets"]
---

# Get Available Snippets for Campaign

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

## Request

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

List the prompt snippets this campaign can use, and whether each one is already assigned. Only snippets your organization can use for the campaign's line of business are included.

## Path parameters

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

## Response `200`

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

- GetV2CampaignsCampaignIdAvailableSnippetsPositiveResponse
  - `snippets` 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
    - `assignedBlockId` string, uuid, nullable, required
  - `total` number, required

## Other responses

- `400`: GET /v2/campaigns/:campaignId/available-snippets Negative response 400
- `401`: GET /v2/campaigns/:campaignId/available-snippets Negative response 401
- `403`: GET /v2/campaigns/:campaignId/available-snippets Negative response 403
- `404`: GET /v2/campaigns/:campaignId/available-snippets Negative response 404
- `409`: GET /v2/campaigns/:campaignId/available-snippets Negative response 409
- `422`: GET /v2/campaigns/:campaignId/available-snippets Negative response 422
- `429`: GET /v2/campaigns/:campaignId/available-snippets Negative response 429
- `500`: GET /v2/campaigns/:campaignId/available-snippets Negative response 500
- `502`: GET /v2/campaigns/:campaignId/available-snippets Negative response 502
- `503`: GET /v2/campaigns/:campaignId/available-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)