Resources
API Reference
- Deals
- Trades
- Lead Events
- VDP Emails
Get Deals
The number of levels of related objects to include in the response
Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
Limit number of results, default 10
Search for results fitting criteria, uses qs library for query string parsing
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Query Parameters
The number of levels of related objects to include in the response
Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
Limit number of results, default 10
Search for results fitting criteria, uses qs library for query string parsing
Response
Current page number
number of next page, null if it doesn't exist
number of previous page, null if it doesn't exist
Total pages available, based upon the limit
Total available records within the database
Limit query parameter, defaults to 10
number of the first record on the current page
true/false if previous page exists
true/false if next page exists