Skip to main content
GET
List contract annexes

Authorizations

Authorization
string
header
required

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

Path Parameters

contractId
string<uuid>
required

The ID of the contract

Query Parameters

startAt
string<date>

Filter annexes with start date greater than or equal to this value

endAt
string<date>

Filter annexes with end date less than or equal to this value

createdAt
string<date>

Filter by creation date

updatedAt
string<date>

Filter by last update date

holidays
integer

Filter by number of holidays

jobCharge.name[contains]
string

Filter by job charge name (partial match)

workdayType.name
string

Filter by workday type name

contractType.name
string

Filter by contract type name

orderBy
enum<string>

Field to order results by. Defaults to 'endAt desc'

Available options:
startAt,
startAt asc,
startAt desc,
endAt,
endAt asc,
endAt desc
limit
integer
default:20

Maximum number of results to return

page
integer
default:1

Page number for pagination

Response

200 - application/json

List of contract annexes retrieved successfully

data
object[]
meta
object