developer notes

Get All Contracts

The ContractGetAll API allows you to retrieve all existing Contracts.

Method	API Endpoint
GET	`{{endpoint}}/api/ext/contracts/filter`

‍

Headers

Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`

‍

Filter Fields

‍

Parameter	Type	Example	Required	Description
`page`	Number	0	`true`	Specifies the page number
`perPage`	Number	25	`true`	Specifies the number of records per page
`startFrom`	Number	0	`true`	Specifies the start point of the column being sorted
`columnName`	String	id	`true`	Specifies the name of the column being sorted
`sortOrder`	String	desc/asc	`true`	Specifies the order in which the column is being sorted
`search`	String	a	`true`	Specifies the search query
`customerId`	Number	1	`false`	Customer ID for filtering
`assetsId`	Number	2	`false`	Assets ID for filtering
`statuses`	String	NEW	`false`	Status of the Contract

‍

API Query Example

‍

Method	API Call
GET	`api/ext/contracts/filter?page=&perPage=&startFrom=&search=b&columnName=id&sortOrder=desc&customerId=1&assetsId=1&statuses=NEW`

‍

Example Response

‍

//status - 200
{
    "total": 0,
    "count": 10,
    "data": [],
    "recordsTotal": 0,
    "recordsFiltered": 0,
    "status": "SEARCH_NO_RESULTS"
}

‍