---
title: "Get routing group"
method: GET
path: "/v2/routing-groups/{id}"
tags: ["Routing Groups"]
---

# Get routing group

`GET /v2/routing-groups/{id}`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/routing-groups/{id}`
- Auth: API key in header `x-api-key`

Look up one routing group by its ID. The response keeps the older transferConfig field names.

## Path parameters

- `id` string, uuid, required: Transfer config ID

## Response `200`

GET /v2/routing-groups/:id Positive response

- GetV2RoutingGroupsIdPositiveResponse
  - `transferConfig` object, required
    - `id` string, uuid, required
    - `clientId` string, uuid, nullable, required
    - `name` string, nullable, required
    - `description` string, nullable, required
    - `configuration` object, required
      - `version` 2, required
      - `destination` union, required
        - object
          - `type` 'direct', required
          - `phoneNumber` string, nullable, required
          - `externalHandoff` object, required
            - `mode` 'cold' | 'warm', required
        - object
          - `type` 'dynamic', required
          - `pingUrl` string
          - `method` 'GET' | 'POST'
          - `timeout` integer
          - `headers` object
          - `body` object
          - `transferNumberField` string
          - `transferNumber` string
          - `successConditions` object[]
            - `field` string, required
            - `operator` 'equals' | 'greater_than' | 'not_equals' | 'contains', required
            - `value` union, required
              - …
          - `fallback` union, required
            - object
              - …
            - object
              - …
            - object
              - …
          - `externalHandoff` object, required
            - `mode` 'cold' | 'warm', required
        - object
          - `type` 'sip', required
          - `uri` string, nullable, required
          - `headers` object, required
          - `externalHandoff` object, required
            - `mode` 'cold' | 'warm', required
        - object
          - `type` 'softphone', required
          - `routingConfigId` string, uuid, nullable, required
          - `handoffStrategy` 'wait-for-operator' | 'immediate-transfer', required
          - `voiceAiFallback` union, required
            - object
              - …
            - object
              - …
            - object
              - …
          - `agentWorkspace` object, required
            - `screenBehavior` 'call-form' | 'customer-details' | 'inbox' | 'none', required
            - `callFormId` string, uuid, nullable, required
          - `agentFirstHandling` object, required
            - `callback` object
              - …
            - `primaryVoicemailGreeting` string, nullable
            - `afterHoursVoicemailGreeting` string, nullable
      - `drafts` object, required
        - `direct` object
          - `type` 'direct', required
          - `phoneNumber` string, nullable, required
          - `externalHandoff` object, required
            - `mode` 'cold' | 'warm', required
        - `dynamic` object
          - `type` 'dynamic', required
          - `pingUrl` string
          - `method` 'GET' | 'POST'
          - `timeout` integer
          - `headers` object
          - `body` object
          - `transferNumberField` string
          - `transferNumber` string
          - `successConditions` object[]
            - `field` string, required
            - `operator` 'equals' | 'greater_than' | 'not_equals' | 'contains', required
            - `value` union, required
              - …
          - `fallback` union, required
            - object
              - …
            - object
              - …
            - object
              - …
          - `externalHandoff` object, required
            - `mode` 'cold' | 'warm', required
        - `sip` object
          - `type` 'sip', required
          - `uri` string, nullable, required
          - `headers` object, required
          - `externalHandoff` object, required
            - `mode` 'cold' | 'warm', required
        - `softphone` object
          - `type` 'softphone', required
          - `routingConfigId` string, uuid, nullable, required
          - `handoffStrategy` 'wait-for-operator' | 'immediate-transfer', required
          - `voiceAiFallback` union, required
            - object
              - …
            - object
              - …
            - object
              - …
          - `agentWorkspace` object, required
            - `screenBehavior` 'call-form' | 'customer-details' | 'inbox' | 'none', required
            - `callFormId` string, uuid, nullable, required
          - `agentFirstHandling` object, required
            - `callback` object
              - …
            - `primaryVoicemailGreeting` string, nullable
            - `afterHoursVoicemailGreeting` string, nullable
      - `warmTransfer` object, required
        - `mode` 'wait-for-operator' | 'immediate-summary', required
        - `summaryPrompt` string, nullable, required
    - `routingConfigId` string, uuid, nullable, required
    - `appointmentConfigId` string, uuid, nullable, required
    - `callFormId` string, uuid, nullable, 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
    - `routingConfig` object, nullable, required
      - `id` string, uuid, required
      - `createdAt` string, date-time, nullable, required: Routing config creation time. ISO 8601 timestamp
      - `updatedAt` string, date-time, nullable, required: Routing config last update time. ISO 8601 timestamp
      - `name` string, required
      - `description` string, nullable, required
      - `routingType` 'linear' | 'balanced' | 'weighted' | 'grouped', required
      - `clientId` string, uuid, required
      - `fallbackBehavior` 'voicemail' | 'schedule_meeting' | 'transfer_to_number', required
      - `fallbackNumber` string, nullable, required
      - `maxRingPerAgent` integer, required
      - `maxWaitTime` integer, required
      - `tryCustomerAgentFirst` boolean, nullable, required
      - `tryPreviousSoftphoneAgentFirst` boolean, nullable, required
      - `customerAgentPriority` integer, nullable, required
      - `previousSoftphoneAgentPriority` integer, nullable, required
      - `tryRequestedAgentFirst` boolean, required
      - `stateBasedRouting` boolean, nullable, required
      - `stateRoutingFallback` 'fallback' | 'all_agents', required
      - `agents` object[], required
        - `id` string, uuid, required
        - `createdAt` string, date-time, nullable, required: Routing agent creation time. ISO 8601 timestamp
        - `updatedAt` string, date-time, nullable, required: Routing agent last update time. ISO 8601 timestamp
        - `routingConfigId` string, uuid, required
        - `memberId` string, uuid, required
        - `groupId` string, uuid, nullable, required
        - `priority` integer, nullable, required
        - `weight` integer, nullable, required
        - `lastCallAt` string, date-time, nullable, required: Routing agent last call time. ISO 8601 timestamp
        - `isActive` boolean, nullable, required
        - `skills` union, required
          - string
          - number
          - boolean
          - object
          - unknown[]
            - unknown
        - `member` object, nullable
          - `id` string, uuid, required
          - `createdAt` string, date-time, required: Member creation time. ISO 8601 timestamp
          - `clientId` string, uuid, required
          - `userId` string, uuid, required
          - `role` string, required
          - `removedAt` string, date-time, nullable, required: Member removal time. ISO 8601 timestamp
          - `removedByUserId` string, uuid, nullable, required
          - `removedReason` string, nullable, required
          - `replacementMemberId` string, uuid, nullable, required
          - `filterData` union, required
            - string
            - number
            - boolean
            - object
            - unknown[]
              - …
          - `user` object, nullable, required
            - `id` string, uuid, required
            - `name` string, nullable, required
            - `email` string, email, required
      - `groups` object[], required
        - `id` string, uuid, required
        - `createdAt` string, date-time, nullable, required: Routing group creation time. ISO 8601 timestamp
        - `updatedAt` string, date-time, nullable, required: Routing group last update time. ISO 8601 timestamp
        - `routingConfigId` string, uuid, required
        - `name` string, required
        - `description` string, nullable, required
        - `routingType` 'linear' | 'balanced' | 'weighted', required
        - `priority` integer, required
        - `isActive` boolean, nullable, required
        - `agents` object[], required
          - `id` string, uuid, required
          - `createdAt` string, date-time, nullable, required: Routing agent creation time. ISO 8601 timestamp
          - `updatedAt` string, date-time, nullable, required: Routing agent last update time. ISO 8601 timestamp
          - `routingConfigId` string, uuid, required
          - `memberId` string, uuid, required
          - `groupId` string, uuid, nullable, required
          - `priority` integer, nullable, required
          - `weight` integer, nullable, required
          - `lastCallAt` string, date-time, nullable, required: Routing agent last call time. ISO 8601 timestamp
          - `isActive` boolean, nullable, required
          - `skills` union, required
            - string
            - number
            - boolean
            - object
            - unknown[]
              - …
          - `member` object, nullable
            - `id` string, uuid, required
            - `createdAt` string, date-time, required: Member creation time. ISO 8601 timestamp
            - `clientId` string, uuid, required
            - `userId` string, uuid, required
            - `role` string, required
            - `removedAt` string, date-time, nullable, required: Member removal time. ISO 8601 timestamp
            - `removedByUserId` string, uuid, nullable, required
            - `removedReason` string, nullable, required
            - `replacementMemberId` string, uuid, nullable, required
            - `filterData` union, required
              - …
            - `user` object, nullable, required
              - …
    - `readiness` object, required
      - `ready` boolean, required
      - `issues` object[], required
        - `section` string, required
        - `message` string, required
    - `usageHash` string
    - `usedByResources` object[]
      - `kind` 'transfer' | 'appointment' | 'scenario', required
      - `id` string, uuid, required
      - `name` string, required
    - `compatibilityWarnings` object[], required
      - `code` 'appointment_fallback_ignored_for_agent_first' | 'agent_first_callback_ignored_for_voice_ai', required
      - `message` string, required
      - `campaignId` string
      - `campaignName` string
      - `campaignKind` 'voice_ai' | 'agent_first'
    - `assignedCampaignCount` number
    - `usedByCampaigns` object[]
      - `id` string, required
      - `name` string, required
      - `kind` string, nullable, required
      - `status` string, nullable, required
    - `usedByReceptionist` boolean

## Other responses

- `400`: GET /v2/routing-groups/:id Negative response 400
- `401`: GET /v2/routing-groups/:id Negative response 401
- `403`: GET /v2/routing-groups/:id Negative response 403
- `404`: GET /v2/routing-groups/:id Negative response 404
- `409`: GET /v2/routing-groups/:id Negative response 409
- `422`: GET /v2/routing-groups/:id Negative response 422
- `429`: GET /v2/routing-groups/:id Negative response 429
- `500`: GET /v2/routing-groups/:id Negative response 500
- `502`: GET /v2/routing-groups/:id Negative response 502
- `503`: GET /v2/routing-groups/:id Negative response 503

## Changes

- **2026-11-02** `db390c743c36`: 1 info
  - added the required property `transferConfig/routingConfig/tryRequestedAgentFirst` to the response with the `200` status

[Operation history](https://skmtc.dev/carecycle/apis/carecycle-public-api/changes/v2/routing-groups/:id/get.md)

---

[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)