API Reference

List all Contracts 🇫🇷

get
https://partner-api.payfit.com/companies//contracts-fr

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the company

Query Params
string

The encoded pagination token

string
Defaults to 10

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

fields
array of strings
deprecated

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)

fields
string
Defaults to false

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

Responses

Updated 7 months ago

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

Updated 7 months ago