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

  1. The exact nature of input and output may vary based on specific system requirements and configurations.

Documentation for Table Column Filters

Filter Operators

OperatorDescription
regexPerforms a regular expression search
gtFilters greater than
ltFilters less than
gteFilters greater than or equal to
lteFilters less than or equal to
eqFilters equal
neFilters not equal
inFilters for values in input array
ninFilters 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

  1. Use appropriate operators for each column type to ensure accurate filtering.
  2. Combine multiple filters to narrow down your search results effectively.
  3. Be mindful of performance when applying complex filters on large datasets.
  4. Validate user input before applying filters to prevent errors.
  5. 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

totalinteger required
pageinteger required
page_sizeinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.