Listing All Sources

Return a paginated list of sources.

API Endpoint

Method URL
GET /v1/sources.json

Request Parameters

Name Type Required? Description
per_page number optional How many sources to return for this request (default 100, maximum 250).
Example: 25
page number optional Page number that should be returned for this request (the first page is 1).
Example: 3
company_id number optional If provided, only return sources belonging to this company.
Example: 395108857

Response Fields

Name Type Description
id number id for the source.
Example: 123456789
name string The name of the source.
Example: “Bob’s Car Garage”
created_at string The date and time the source was created in UTC, in ISO 8601 format.
Example: “2011-07-05T19:06:10Z”
disabled_at string If the source has been disabled, this will be the date and time the source was disabled (UTC, ISO 8601 format). If the source is still enabled, this value will be null.
Example: “2012-08-05T19:06:10Z”
company_name string The name of the company the source belongs to.
Example: “Bob’s Auto Garage”
company_id number The numeric id of the company the source belongs to.
Example: 123456789
destination_number string The phone number that will ring when this tracking number is called, sent as a string in E.164 format.
Example: “+17701112222”
tracking_numbers array An array of tracking phone numbers for this source. For source tracking numbers, this will be a single number. For keyword pools, this will be a collection of numbers.
Example: ["+16781112222"]
type string The type of tracking number, either “Source” or “Session”.


curl -H "Authorization: Token token=abc1234" \
  "page": 1,
  "per_page": 250,
  "total_pages": 1,
  "total_records": 18,
  "sources": [
      "id": 240917258,
      "name": "Google Organic",
      "disabled_at": null,
      "created_at": "2012-06-20T19:14:26Z",
      "company_name": "LMM",
      "company_id": 254822795,
      "destination_number": "+17701112222",
      "tracking_numbers": [ "+16781112222" ],
      "type": "Source"
      "id": 335667046,
      "name": "Keyword Pool",
      "disabled_at": null,
      "created_at": "2012-06-20T19:18:39Z",
      "company_name": "LMM",
      "company_id": 254822795,
      "destination_number": "+17705985444",
      "tracking_numbers": [
        "+16788904153", "+16786192646", "+16782562589", "+16782562650", "+16788905394",
        "+16788905403", "+16789292938", "+16783698047", "+16782562603", "+16787524454"