Skip to main content
GET
/
v2
/
sources
List all sources
curl --request GET \
  --url https://api.carecycle.ai/v2/sources \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sourceId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phoneNumberId": -1,
      "dealType": "CPA",
      "sourceType": "outbound",
      "pricingModel": "flat_rate",
      "payout": "<string>",
      "commissionPerSale": "<string>",
      "leadCost": "<string>",
      "durationThreshold": "<string>",
      "enabled": true,
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>",
      "campaignName": "<string>"
    }
  ],
  "itemsTotal": 123,
  "currentPage": 123,
  "nextPage": 123,
  "prevPage": 123
}

Authorizations

x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Query Parameters

page
number
default:1

GET /v2/sources Parameter

Required range: x >= 1
perPage
number
default:50

GET /v2/sources Parameter

Required range: 1 <= x <= 100

GET /v2/sources Parameter

enabled
boolean

GET /v2/sources Parameter

dealType
enum<string>

GET /v2/sources Parameter

Available options:
CPL,
CPA
campaignId
string<uuid>

GET /v2/sources Parameter

Response

GET /v2/sources Positive response

items
object[]
required
itemsTotal
number
required
currentPage
number
required
nextPage
number | null
required
prevPage
number | null
required