Param name |
Description
Validations
|
---|---|
owner_id Optional |
The ID for the record that owns this record.
|
owner_type Optional |
The type of record that owns this record.
|
owner_relation Optional |
The relation.
|
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
|
---|---|
owner_id Required |
The ID for the record that owns this record.
|
owner_type Required |
The type of record that owns this record.
|
owner_relation Required |
The relation.
|
open_times Optional |
Define the days and hours that are open. EX:
|
sortable_order Optional Blank Value Allowed |
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
|
Param name |
Description
Validations
|
---|---|
owner_id Required |
The ID for the record that owns this record.
|
owner_type Required |
The type of record that owns this record.
|
owner_relation Required |
The relation.
|
open_times Optional |
Define the days and hours that are open. EX:
|
sortable_order Optional Blank Value Allowed |
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
|
Param name |
Description
Validations
|
---|---|
open_times Optional |
Define the days and hours that are open. EX:
|
sortable_order Optional Blank Value Allowed |
The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.
|