---
title: "List all sources"
method: GET
path: "/v2/sources"
tags: ["Sources"]
---

# List all sources

`GET /v2/sources`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/sources`
- Auth: API key in header `x-api-key`

List your lead sources: the vendors and channels your leads and calls come from. Results come back one page at a time.

## Query parameters

- `page` number
- `perPage` number
- `search` string
- `enabled` union
  - boolean
  - 'true' | 'false'
- `dealType` 'CPA' | 'CPL'
- `campaignId` string, uuid
- `direction` 'outbound' | 'inbound'

## Response `200`

GET /v2/sources Positive response

- GetV2SourcesPositiveResponse
  - `items` object[], required
    - `id` string, uuid, required
    - `sourceId` string, required
    - `clientId` string, uuid, required
    - `name` string, nullable, required
    - `description` string, nullable, required
    - `label` string, nullable
    - `type` string, nullable
    - `channel` string, nullable
    - `status` 'active' | 'inactive' | 'archived', required
    - `dealType` 'CPA' | 'CPL', required
    - `pricingModel` 'flat_rate' | 'percentage' | 'dynamic' | 'static' | 'duration', required
    - `payout` string, nullable, required
    - `commissionPerSale` string, nullable, required
    - `leadCost` string, nullable, required
    - `durationThreshold` string, nullable, required
    - `externalRefs` object, nullable
    - `metadata` object, nullable
    - `createdAt` string, date-time, nullable, required: Source creation time. ISO 8601 timestamp
    - `updatedAt` string, date-time, nullable, required: Source last update time. ISO 8601 timestamp
    - `assignments` object[], required
      - `id` string, uuid, required
      - `sourceId` string, uuid, required
      - `campaignId` string, uuid, required
      - `campaignName` string, nullable
      - `direction` 'outbound' | 'inbound', required
      - `enabled` boolean, required
      - `phoneNumberId` integer, nullable, required
      - `phoneNumber` string, nullable
      - `service` 'mobius' | 'softphone' | 'null', nullable
      - `assignedAt` string, date-time, nullable, required: Source assignment time. ISO 8601 timestamp
      - `unassignedAt` string, date-time, nullable, required: Source unassignment time. ISO 8601 timestamp
    - `assignmentCount` integer, required
    - `leadDestinationCampaignId` string, uuid, nullable
    - `leadDestinationCampaignName` string, nullable
  - `itemsTotal` number, required
  - `currentPage` number, required
  - `nextPage` number, nullable, required
  - `prevPage` number, nullable, required

## Other responses

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