---
title: "Search Contracts"
method: GET
path: "/v2/contract"
tags: ["Contracts"]
---

# Search Contracts

`GET /v2/contract`

# 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

```json
{
    "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

| 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

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.

## Query parameters

- `page` integer
- `page_size` integer

## Headers

- `authorization` string, required — The authorization token can be retrieved by calling the OAuth authentication API. The value for this header parameter follows the format "Bearer &nbsp;&nbsp; `access_token`" (excluding the quotes). For example: <br /> `Bearer MZA1YJMYZDKTZTFMMI0ZYZG1LTLMMDGTYTG4NJG2YZC3NJGY`

## Response `200`

Successful Response

- DocumentSearchResponse
  - `data` DocumentResponse[], required
    - `id` string, required
    - `document_subtype` DocumentSubTypeResponse, required
      - `id` string, required
      - `name` string, required
      - `description` string
      - `type` 'License Agreement' | 'Beta Test Agreement' | 'Proof of Concept Agreement' | 'Statement of Work' | 'Service Level Agreement' | 'Master Service Agreement' | 'Non-Disclosure Agreement (NDA)' | 'Maintenance and Support Agreement (MSA)' | 'Software Development Agreement (SDA)' | 'End User License Agreement (EULA)' | 'Purchase Order' | 'Invoice' | 'Custom' | 'Custom Document' | 'Contract' | 'Service Organization Control 2 (SOC 2)', required — An enumeration.
      - `slug` string, required
      - `page` union, required
        - string
        - PageResponse
          - `id` string, required
          - `slug` string, required
          - `name` string, required
          - `sections` SectionResponse[], required
            - `id` string, required
            - `name` string, required
            - `table` TableResponse
              - …
            - `sequence` integer, required
            - `is_hidden` boolean
            - `created_at` string, date-time, required
            - `updated_at` string, date-time, required
            - `fields` FieldResponse[]
              - …
          - `sequence` integer, required
          - `created_at` string, date-time, required
          - `updated_at` string, date-time, required
          - `is_hidden` boolean, required
      - `is_contract` boolean, required
      - `updated_at` string, date-time, required
    - `folder` FolderResponse
      - `id` string, required
      - `name` string, required
      - `parent_folder` FolderResponse — recursive
    - `entity` ServicesAppcatalogSchemaEntityEntityResponse, required
      - `id` string, required
      - `name` string, required
      - `logo` string
      - `slug` string, required
      - `entity_type` EntityTypeResponse, required
        - `slug` string, required
        - `name` string, required
        - `is_catalog` boolean, required
        - `is_hidden` boolean, required
      - `vendor_managers` CollaboratorResponse[]
        - `id` string, required
        - `auth_role` string
        - `type` 'USER' | 'TEAM' | 'ROLE', required — An enumeration.
        - `name` string
        - `email` string
        - `access_modes` AccessType[]
    - `files` object[], required
    - `owners` object[], required
    - `collaborators` DocumentColloboratorResponse[]
      - `type` 'USER' | 'TEAM' — An enumeration.
      - `data` union
        - SharedSchemaUserResponse
          - `id` string, required
          - `name` string, required
          - `email` string, required
        - SharedSchemaTeamResponse
          - `id` string, required
          - `name` string, required
      - `role` 'READ' | 'WRITE' — An enumeration.
    - `name` string
    - `start_date` string, date-time
    - `end_date` string, date-time
    - `status` object, required
    - `renewal_date` string, date-time
    - `renewal_status` object
    - `project_id` string
    - `source_project_id` string
    - `discrepencies` integer
    - `missing_clauses_count` integer
    - `partial_compliance_count` integer
    - `is_contract` boolean, required
    - `risk_severity` object
    - `role` 'READ' | 'WRITE' — An enumeration.
    - `updated_at` string, date-time, required
  - `total` integer, required
  - `page` integer, required
  - `page_size` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/expent/apis/expent-apis.md) · [All operations](https://skmtc.dev/expent/apis/expent-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/expent/expent-apis/revisions/ce1d50af5e2c/schema)