Skip to content

Contracts — list screen

The contract list screen (newer version): filtering, sorting and exporting the contract grid.

Reading, creating, changing or deleting single records? Use Contracts.

Base path
/api-v2/contracts

Endpoints

3 endpoints

Method

Additional Operations

3
  • POST /api-v2/contracts/list Load the contracts list screen: the table with filters, sorting and paging.
    Details

    Request body

    Search, filters and paging for a list screen. Required.

    NameTypeDescription
    filtersobject
    filters.searchstringExample: hosting
    filters.pageintegerMinimum 1. Example: 1
    filters.limitintegerMinimum 1. Example: 20
  • POST /api-v2/contracts/exportData Download the contracts list screen as a spreadsheet.
  • GET /api-v2/contracts/contracts-end-date-alert List contracts that are close to their end date.