GET /api/v1/collections/:type
Get a collection.

Supported Formats

json, csv

Params

Param name
Description
Validations
type
Required

The type of collection to return.

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    buyer_group_table_detailsBuyer Group Table Details
    buyer_table_detailsBuyer Table Details
    call_buyer_idCall Buyer
    call_categoryCall Category
    call_child_buyer_idCall Child Buyer
    call_contact_field_typeCall Contact Field Type
    call_countryCall Country
    call_hangup_cause_codeCall Hangup Cause Code
    call_hangup_cause_statusCall Hangup Cause Status
    call_hung_up_byCall Hung Up By
    call_offer_idCall Offer
    call_report_table_detailsCall Report Table Details
    call_state_provinceCall State Province
    call_statusCall Status
    call_sub_idCall Sub
    call_table_detailsCall Table Details
    call_token_values_mapCall Token Values Map
    call_zip_postal_codeZip / Postal Codes On Calls
    countriesCountries
    facet_categoriesFacet Categories
    lead_contact_field_typeLead Contact Field Type
    lead_countryLead Country
    lead_dial_number_idLead Dial Number
    lead_dial_tierLead Dial Tier
    lead_lead_import_idLead Lead Import
    lead_report_table_detailsLead Report Table Details
    lead_schedule_trigger_typeLead Schedule Trigger Type
    lead_sms_number_idLead Sms Number
    lead_state_provinceLead State Province
    lead_statusLead Status
    lead_statusLead Status
    lead_sub_idLead Sub
    lead_table_detailsLead Table Details
    lead_token_values_mapLead Token Values Map
    lead_zip_postal_codeLead Zip Postal Code
    number_table_detailsNumber Table Details
    offer_table_detailsOffer Table Details
    ring_pool_table_detailsRing Pool Table Details
    schedule_table_detailsSchedule Table Details
    statesStates
    time_zoneTime Zone
    traffic_source_table_detailsTraffic Source Table Details
    webhook_ipsWebhook Ips
created_at_label
Optional Blank Value Allowed

Dynamic Date String such as “Today” or “This Year”

Validations:

  • Must be one of: Last 5 Min, Last 15 Min, Last 30 Min, Last Hour, Last 4 Hours, Last 6 Hours, Last 12 Hours, Last Day, Last 2 Days, Today, Yesterday, This Week, Last Week, This Month, Last Month, This Quarter, Last Quarter, Last 6 Months, This Year, Last Year, Lifetime, Custom Range.
created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

Validations:

  • Must be a String
created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

Validations:

  • Must be a String
query
Optional

Search for any record that matches this text

Validations:

  • Must be a String