Get a List of Contracts

Retrieve a paginated list of contracts in your SysAid account.

Query Params
integer
≥ 0
Defaults to 0

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

integer
1 to 500
Defaults to 20

The number of records to return per page, up to 500.

string

Query to search entities.

string
enum
Defaults to dateCreated

The field by which results are sorted. The default is "dateCreated".

string
enum
Defaults to desc

The direction in which results are sorted. The default is "desc" (descending).

Allowed:
status
array of strings

Filter results by one or more contract statuses.

status
type
array of strings

Filter results by one or more contract types.

type
category
array of strings

Filter results by one or more contract categories.

category
date

The earliest start date to include in the results (inclusive).

date

The latest start date to include in the results (inclusive).

date

The earliest end date to include in the results (inclusive).

date

The latest end date to include in the results (inclusive).

number
≥ 0

The minimum contract value to include in the results (inclusive).

number
≥ 0

The maximum contract value to include in the results (inclusive).

integer
≥ 0

The minimum number of licenses to include in the results (inclusive).

integer
≥ 0

The maximum number of licenses to include in the results (inclusive).

Responses

Language
Credentials
Bearer
JWT
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json