Param name |
Description
Validations
|
---|---|
ids Optional |
Return records matching these ids.
|
page Optional |
Return the next page of results.
|
per_page Optional |
How many results to return per page. The default is 25.
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
fulltext Optional |
Search for any record that matches this text
|
time_zone Optional |
Date ranges will be parsed using this time zone.
|
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:
|
root Optional |
Pass
|
Param name |
Description
Validations
|
---|---|
outgoing_webhook_url_id Optional Blank Value Allowed |
translation missing: en.api.response_parsers.outgoing_webhook_url_id
|
buyer_conversion_id Optional Blank Value Allowed |
Buyer Conversion
|
name Optional Blank Value Allowed |
Name
|
description Optional Blank Value Allowed |
Description
|
webhook_response_success_codes Optional Blank Value Allowed |
Acceptable HTTP Status Codes
|
key Optional Blank Value Allowed |
Token Key
|
value_path Optional Blank Value Allowed |
Provide the path to extract a value. EG: lead.id
|
created_at Optional Blank Value Allowed |
Created At
|
updated_at Optional Blank Value Allowed |
Updated At
|
Param name |
Description
Validations
|
---|---|
outgoing_webhook_url_id Optional Blank Value Allowed |
translation missing: en.api.response_parsers.outgoing_webhook_url_id
|
buyer_conversion_id Optional Blank Value Allowed |
Buyer Conversion
|
name Optional Blank Value Allowed |
Name
|
description Optional Blank Value Allowed |
Description
|
webhook_response_success_codes Optional Blank Value Allowed |
Acceptable HTTP Status Codes
|
key Optional Blank Value Allowed |
Token Key
|
value_path Optional Blank Value Allowed |
Provide the path to extract a value. EG: lead.id
|
created_at Optional Blank Value Allowed |
Created At
|
updated_at Optional Blank Value Allowed |
Updated At
|
Param name |
Description
Validations
|
---|---|
outgoing_webhook_url_id Optional Blank Value Allowed |
translation missing: en.api.response_parsers.outgoing_webhook_url_id
|
buyer_conversion_id Optional Blank Value Allowed |
Buyer Conversion
|
name Optional Blank Value Allowed |
Name
|
description Optional Blank Value Allowed |
Description
|
webhook_response_success_codes Optional Blank Value Allowed |
Acceptable HTTP Status Codes
|
key Optional Blank Value Allowed |
Token Key
|
value_path Optional Blank Value Allowed |
Provide the path to extract a value. EG: lead.id
|
created_at Optional Blank Value Allowed |
Created At
|
updated_at Optional Blank Value Allowed |
Updated At
|