Skip to main content
GET
Get contracts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
default:1

Page number (default: 1). Set to false to disable pagination.

perPage
integer
default:20

Number of items per page (default: 20).

filters
string

URL-encoded JSON object with filter criteria.

Body

application/json
with_milestones
boolean

Include milestones in each contract response.

with_ratecards
boolean

Include ratecards in each contract response.

with_positions
boolean

Include contract positions in each contract response.

status
string

Filter contracts by status.

Example:

"expired"

type
string

Filter contracts by type.

Example:

"time_and_materials"

Response

200 - application/json

Paginated list of contracts

Paginated response for contracts list

total

Total number of contracts

perPage

Number of items per page

page

Current page number

data
object[]

Array of contracts for the current page