v1

latestOpenAPI 3.0.02026-07-24310185.2 KB
Contract

List all Contracts πŸ‡«πŸ‡·

Returns all Contracts with french specific data. This list is paginated.
Required scopes: contracts:read

get/companies/{companyId}/contracts-fr

Path parameters

companyIdstring required

The id of the company

Query parameters

nextPageTokenstring

The encoded pagination token

maxResultsstring

Allows to define the maximum number of items to fetch at once. (Max: 50, Default: 10)

fieldsstring[]

Deprecated. The groups of fields to include in the response, in addition to the default fields. | Possible values are "securite-sociale" (it will require the collaborators:social-security:read oauth scope)

includeInProgressContractsstring

Allow to returns the in progress contracts (or in creation)

Response

All active, pending and last year archived contracts