listContracts
listContractsRetrieve a paginated list of contracts with filters for ID, customer, name, start/end dates, creation date, and status.
Instructions
Retrieve a paginated list of contracts, with extensive options for filtering by ID, customer ID, name, start date, end date, creation date, and status.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | The cursor for pagination to fetch the next or previous set of records. | |
| limit | No | Maximum number of records to return per page (defaults to 10). | |
| order | No | Order of results (e.g., '-created_at' for descending creation date). | -created_at |
| id | No | Filter by Contract ID (exact match). | |
| id__in | No | Filter by a comma-separated list of Contract IDs. | |
| id__isnull | No | Filter by whether Contract ID is null. | |
| customer_id | No | Filter by Customer ID (exact match). | |
| customer_id__in | No | Filter by a comma-separated list of Customer IDs. | |
| customer_id__isnull | No | Filter by whether Customer ID is null. | |
| name | No | Filter by Contract Name (exact match). | |
| name__ilike | No | Contract Name (case-insensitive partial match). | |
| name__like | No | Contract Name (case-sensitive partial match). | |
| name__in | No | Filter by a comma-separated list of Contract Names. | |
| name__isnull | No | Filter by whether Contract Name is null. | |
| start_date | No | Contract Start Date (exact match, ISO 8601). | |
| start_date__neq | No | Contract Start Date (not equal, ISO 8601). | |
| start_date__gt | No | Contract Start Date (greater than, ISO 8601). | |
| start_date__gte | No | Contract Start Date (greater than or equal to, ISO 8601). | |
| start_date__lt | No | Contract Start Date (less than, ISO 8601). | |
| start_date__lte | No | Contract Start Date (less than or equal to, ISO 8601). | |
| start_date__isnull | No | Filter by whether Contract Start Date is null. | |
| start_date__in | No | Filter by a comma-separated list of Contract Start Dates. | |
| created_at | No | Contract Created At (exact match, ISO 8601). | |
| created_at__neq | No | Contract Created At (not equal, ISO 8601). | |
| created_at__gt | No | Contract Created At (greater than, ISO 8601). | |
| created_at__gte | No | Contract Created At (greater than or equal to, ISO 8601). | |
| created_at__lt | No | Contract Created At (less than, ISO 8601). | |
| created_at__lte | No | Contract Created At (less than or equal to, ISO 8601). | |
| created_at__isnull | No | Filter by whether Contract Created At is null. | |
| created_at__in | No | Filter by a comma-separated list of Contract Creation Dates. | |
| end_date | No | Contract End Date (exact match, ISO 8601). | |
| end_date__neq | No | Contract End Date (not equal, ISO 8601). | |
| end_date__gt | No | Contract End Date (greater than, ISO 8601). | |
| end_date__gte | No | Contract End Date (greater than or equal to, ISO 8601). | |
| end_date__lt | No | Contract End Date (less than, ISO 8601). | |
| end_date__lte | No | Contract End Date (less than or equal to, ISO 8601). | |
| end_date__isnull | No | Filter by whether Contract End Date is null. | |
| end_date__in | No | Filter by a comma-separated list of Contract End Dates. | |
| status | No | Filter contracts by their status. | |
| status__in | No | Filter by a comma-separated list of contract statuses. | |
| __userContext | No | Internal user context for multi-tenant authentication and approval workflow |