Retrieves a list of contracts with optional filtering, sorting, and pagination.
Endpoint
GET /contractsAuthentication
Required: Authorization header with valid token
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
sortBy | string | No | Field to sort by | updatedAt |
sortDirection | string | No | Sort direction | DESC |
updatedAfter | date-time | No | Filter contracts updated after this date | 2024-01-01T00:00:00Z |
search | string | No | Search term for contract title/description | construction |
clientId | uuid | No | Filter by specific client | 75f18aa7-b0aa-4d2c-b104-b513bec82a5f |
status | string | No | Filter by contract status | IN_PROGRESS |
page | number | No | Page number (default: 1) | 1 |
limit | number | No | Items per page (default: 20) | 20 |
Response
Success (200)
{
"content": [
"ContractEntity"
],
"total": "number"
}Response Field Descriptions:
content- Array of contract objects (ContractEntity Schema)total- Total number of contracts matching the query criteria
Example Usage
curl -X GET "https://integration-api.ram.syniotec.com/master-data/v1/contract-management/contracts" \
-H "Authorization: Bearer YOUR_TOKEN"