General Parameters
Searching
Query string parameters
q
string - Search query.
Pagination
Query string parameters
per_page
integer - How many correspondences to show per page. Max is 50.page
integer - Which page to show.
Sorting
Query string parameters
sort_by
string - Different supported values will be listed at the reference.sort_direction
string- Can be
asc
ordesc
- Can be
Fields
Parameters
fields
- arrayfields.*.id
- uuid- Required
- Must be a valid
field_id
fields.*.value
- array, boolean, number or string- Required
- Must pass the validation for
fields.*.id
if the field hasvalidation
- Must be array if
fields.*.id
hasoptions
fields.*.value.*
- uuid- Must be valid
option_id
forfields.*.id
- Must be valid
Backdating
Query string parameters
backdate
bool - If the entity will be backdated
Payload
created_at
- date- Y-m-d H:i:s format.
- Required if
backdate
istrue
Webhooks will be emitted when backdating.