Get Service Contracts

get

https://{dc-region}.zuperpro.com/api/service_contract

Query Params

page

int32

Defaults to 1

Page number to fetch

count

int32

Defaults to 10

Number of contracts in the page

sort

string

enum

Defaults to DESC

Sort order

Allowed:

sort_by

string

enum

Defaults to contract_number

Sort type

Allowed:

filter.keyword

string

Keyword search based on Service Contracts name,number,ref_no,customer address,billing address and email

filter.is_active

boolean

Filter by active contracts

filter.is_deleted

boolean

Filter by deleted contracts

filter.custom_field

string

Filter by contract's custom field

filter.organization_uid

string

Filter by organization uid

filter.updated_at_from

date

Filter by contract updated date from

filter.updated_at_to

date

Filter by contract updated date to

filter.is_expired

boolean

Filter by contract's expire status

filter.approval_status

boolean

Filter by approval status

filter.contract_total_from

int32

Filter by contract total amount

filter.contract_total_to

int32

Filter by contract total amount

filter.await_approval_by

string

Filter by approver

filter.customer

string

Filter by customer uids

filter.end_from

date

Filter by contract end from

filter.end_to

date

Filter by Contract end to

filter.asset

string

Filter by asset uids

filter.updated_at

date

Filter by contract updated date

filter.contract_uid

string

Filter by contract uids

filter.expiring_fd

date

Filter by expiring from date

filter.expiring_td

date

Filter by expiring to date

filter.property

string

Filter by property uids

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

500500