Contracts
Contract documents
Retrieves contracts
get
/contractsReturns a paginated list of contract documents.
Contracts track agreements with clients including status, start/end dates.
Query parameters
- Page number for pagination
pageintegerDefault:1Example:1 - Number of records per page
limitintegerDefault:25Example:25 - Field to order results by
order_bystringDefault:created_atExample:created_at - Sort direction (asc or desc)
sortstringValues:ascdescDefault:desc
Responses
200contracts found401unauthorized
Request
curl -X GET 'https://api.vixiees.com/api/v1/contracts' \
-H 'X-Api-Key: YOUR_API_KEY'Example response 路 200
{
"results": [
{
"_id": "string",
"name": "string",
"status": "string",
"start_date": "2024-01-01T00:00:00Z",
"end_date": "2024-01-01T00:00:00Z",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
],
"page_info": {
"current_page": 0,
"limit": 0
}
}