Param name |
Description
Validations
|
||||||||
---|---|---|---|---|---|---|---|---|---|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
||||||||
page Optional |
Return the next page of results. Validations:
|
||||||||
per_page Optional |
How many results to return per page. The default is 25. Validations:
|
||||||||
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
||||||||
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
||||||||
fulltext Optional |
Search for any record that matches this text Validations:
|
||||||||
time_zone Optional |
Date ranges will be parsed using this time zone. Validations:
|
||||||||
columns Optional |
Specify the columns you would like returned by the API for a given resource.
Limiting the columns can significantly increase API response time since only the requested data will be processed.
columns=uuid,number,created_at
Must be any combination of:
Validations:
|
||||||||
root Optional |
Pass Validations:
|
||||||||
created_at_label Optional Blank Value Allowed |
Dynamic Date String such as “Today” or “This Year” Validations:
|
||||||||
next_action_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
||||||||
next_action_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
||||||||
offer_id Optional |
Refer to the offer api for details Validations:
|
||||||||
schedule_id Optional |
Schedule internal id. Validations:
|
||||||||
contact_id Optional |
Match calls that were placed by this caller. Validations:
|
||||||||
traffic_source_id Optional |
Refer to the traffic source api for details Validations:
|
||||||||
buyer_id Optional |
Refer to the buyer api for details Validations:
|
||||||||
status Optional |
Match results that have this status. Validations:
|
||||||||
status_wait Optional |
Filter for leads that are waiting before performing an action. Validations:
|
||||||||
number Optional |
Filter for leads matching this callerid. Validations:
|
||||||||
email Optional |
The email address for the lead. The lead's email is required for sending emails from schedules to leads. Validations:
|
||||||||
has_next_action Optional |
Filter for leads that have more actions to perform. Validations:
|
||||||||
buyer_converted Optional |
Select leads that have converted. Validations:
|
||||||||
offer_converted Optional |
Select leads where a traffic source converted. Validations:
|
||||||||
either_converted Optional |
Select leads where either a buyer or traffic source converted. Validations:
|
||||||||
opt_out Optional |
Select leads that have opted-out. Validations:
|