---
title: "Get Swarm Config"
method: GET
path: "/core/agents/{agent_id}/ivr-swarm/config"
tags: ["ivr-swarm"]
---

# Get Swarm Config

`GET /core/agents/{agent_id}/ivr-swarm/config`

## Request

- Base URL: `https://api.anyreach.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.anyreach.ai/core/agents/{agent_id}/ivr-swarm/config`
- Auth: HTTP bearer

## Path parameters

- `agent_id` string, uuid, required

## Headers

- `x-anyreach-org` string, nullable: Organization ID for user PATs (pat_ prefix tokens)

## Response `200`

Successful Response

- SwarmConfigOut
  - `id` string, nullable
  - `agent_id` string, required
  - `target_id` string, nullable
  - `target` Target
    - `id` string, required
    - `label` string, required
    - `number` string, required
    - `caller_id` string, nullable
    - `max_duration_s` integer, required
    - `load_test_authorized` boolean
    - `load_test_authorized_by` string, nullable
    - `load_test_authorized_at` string, date-time, nullable
    - `load_test_note` string, nullable
    - `company_name` string, nullable
    - `website` string, nullable
    - `do_not_test` boolean
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `modified_by` string, nullable
  - `config` SwarmConfig, required
    - `v` 1
    - `goals` Goal[]
      - `key` string, required
      - `label` string, required
      - `spoken_ask` string, required
      - `expected_answer` string
      - `source` 'generated' | 'manual' | 'builtin'
    - `profiles` Profile[]
      - `id` string, required
      - `first_name` string, required
      - `last_name` string, required
      - `date_of_birth` string, required: YYYY-MM-DD
      - `member_id` string
      - `account_number` string
      - `policy_number` string
      - `group_number` string
      - `order_number` string
      - `claim_number` string
      - `ssn_last4` string
      - `ssn` string
      - `phone` string
      - `email` string
      - `street` string
      - `city` string
      - `state` string
      - `zip` string
      - `pin` string
      - `note` string
    - `profile_formats` ProfileFormats: Lengths and prefixes the seeded numbers follow for this line, so they look like the company's own numbers.
      - `member_id_length` integer
      - `member_id_prefix` string
      - `account_number_length` integer
      - `order_number_length` integer
      - `claim_number_length` integer
    - `seed` integer
    - `defaults` RunDefaults
      - `agents` integer
      - `mix` 'balanced' | 'hard'
      - `ramp` 'stagger' | 'burst'
      - `concurrency` integer
    - `on_live_agent` 'hang_up' | 'stay'
    - `max_hold_wait_s` integer
    - `persona_voices` object
  - `updated_at` string, date-time, nullable
  - `is_default` boolean, required
  - `max_concurrency` integer

## Other responses

- `422`: Validation Error

---

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