Contracts
Search Contracts
Filter Contracts
Request Parameters
Pagination Options
- page: Page number (starting from 0)
- page_size: Number of items per page
Filtering Options
- filters: Array of Filter Objects
Request Body
{
"start_date": [
{
"operator": "asc"
}
],
"document-multiselect-ms_table_lookup": [
{
"operator": "in",
"query": [
"op2"
]
}
]
}
Response
Array of Contracts
Notes
- The exact nature of input and output may vary based on specific system requirements and configurations.
Documentation for Table Column Filters
Filter Operators
| Operator | Description |
|---|---|
| regex | Performs a regular expression search |
| gt | Filters greater than |
| lt | Filters less than |
| gte | Filters greater than or equal to |
| lte | Filters less than or equal to |
| eq | Filters equal |
| ne | Filters not equal |
| in | Filters for values in input array |
| nin | Filters for values not in input array |
Column Types and Supported Filters
1. Text
- Supported Operators: regex
- Query Example: "expe"
2. Date
- Supported Operators: gte, lte, eq, gt, lt
- Query Example: "2023-01-01"
3. SingleSelect
- Supported Operators: gte, lte, eq, gt, lt
- Query Example: "0"
4. Binary
- Supported Operators: in, nin
- Query Example: "[true, false]"
5. MultiSelect
- Supported Operators: in, nin
- Query Example: "[0, 1]"
6. Phone
- Supported Operators: regex
- Query Example: "+123"
7. Email
- Supported Operators: regex
- Query Example: "john@vert"
8. User
- Supported Operators: in, nin
- Query Example: "[42, 6]"
9. Team
- Supported Operators: in, nin
- Query Example: "[9]"
10. Number
- Supported Operators: gt, gte, lt, lte, eq, ne
- Query Example: "111"
11. File
- Supported Operators: regex
- Query Example: "april renewals"
12. Url
- Supported Operators: regex
- Query Example: "google.co"
13. Currency
- Supported Operators: gte, lte
- Query Example: "500"
Best Practices
- Use appropriate operators for each column type to ensure accurate filtering.
- Combine multiple filters to narrow down your search results effectively.
- Be mindful of performance when applying complex filters on large datasets.
- Validate user input before applying filters to prevent errors.
- Use pagination to manage large result sets efficiently.
get/v2/contract
Query parameters
pageinteger
page_sizeinteger
Headers
authorizationstring required
The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY
The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer access_token" (excluding the quotes). For example: <br /> Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY
Response
Successful Response
Changes
No recorded changes to this endpoint across all 1 revision of this API.