ZUzuper

Get Service Contracts By Filter

Changed on

Rule-engine-based list endpoint — an alternative to the simple filter.* query params on the plain list endpoint, for building complex AND/OR filter conditions. Supports cursor pagination (cursor_pagination/cursor/prev_cursor/last_page) and fields_to_select. filter.module_uid restricts to specific contract_uids.

post/service_contract/filter

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/service_contract/filter
  • Auth
    API key in header x-api-key

Request body

pageinteger
limitinteger
sort'ASC' | 'DESC'
filter_rule_operator'AND' | 'OR'
sort_by'contract_number' | 'end_date' | 'start_date' | 'created_at' | 'updated_at'
cursorstring
prev_cursorstring
cursor_paginationboolean
last_pageboolean
filter.module_uidstring
fields_to_selectstring
preferred_timezonestring

Response

200

type'success'
dataobject[]

Service contract documents — same shape as GET /service_contract.

total_recordsinteger
current_pageinteger

0 in cursor-paginated mode.

total_pagesinteger

0 in cursor-paginated mode.

Changes