--- updatedAt: 2026-06-29T09:41:37.000Z agentTools: projectIndex: https://developers.payfit.io/llms.txt --- # List all Contracts 🌍 Returns all Contracts. This list is paginated. \ **Required scopes**: *contracts:read* # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Partner API", "description": "An API to let third parties communicate with PayFit", "version": "1.0" }, "servers": [ { "url": "https://partner-api.payfit.com", "description": "The PayFit API production server" } ], "paths": { "/companies/{companyId}/contracts": { "get": { "operationId": "GET_contracts", "summary": "List all Contracts 🌍", "description": "Returns all Contracts. This list is paginated.\n\\\n**Required scopes**: *contracts:read*", "tags": [ "Contract" ], "parameters": [ { "in": "path", "name": "companyId", "schema": { "type": "string" }, "required": true, "description": "The id of the company" }, { "in": "query", "name": "nextPageToken", "required": false, "schema": { "title": "nextPageToken", "type": "string", "additionalProperties": false }, "description": "The encoded pagination token" }, { "in": "query", "name": "maxResults", "required": false, "schema": { "title": "maxResults", "type": "string", "additionalProperties": false, "default": "10" }, "description": "Allows to define the maximum number of items to fetch at once. (Max: 50, Default: 10)" }, { "in": "query", "name": "includeInProgressContracts", "schema": { "type": "string", "default": "false" }, "required": false, "description": "Allow to returns the in progress contracts (or in creation)" } ], "responses": { "200": { "description": "All active, pending and last year archived contracts", "content": { "application/json": { "schema": { "title": "contracts", "type": "object", "additionalProperties": false, "properties": { "contracts": { "type": "array", "items": { "title": "contract", "allOf": [ { "type": "object", "title": "contract", "allOf": [ { "type": "object", "title": "timeInformation", "description": "It will contain every information related to the time information", "properties": { "standardWeeklyHours": { "type": "number", "nullable": true, "description": "Weekly hours defined in the contract. It will be available if `contracts:time-information:read` scope is set on the token." }, "fullTimeEquivalent": { "type": "number", "nullable": true, "description": "Percentage of weekly hours in the contract. It will be available if `contracts:time-information:read` scope is set on the token." }, "isFullTime": { "type": "boolean", "nullable": true, "description": "Will be set to `true` if `fullTimeEquivalent` is at 1. It will be available if `contracts:time-information:read` scope is set on the token." } }, "required": [ "standardWeeklyHours", "fullTimeEquivalent", "isFullTime" ] }, { "type": "object", "properties": { "contractId": { "type": "string", "description": "Id of the contract." }, "companyId": { "type": "string", "description": "Id of the contract's company." }, "startDate": { "type": "string", "format": "date", "nullable": true, "description": "Contract start date." }, "endDate": { "type": "string", "format": "date", "nullable": true, "description": "Contract end date." }, "probationEndDate": { "type": "string", "format": "date", "nullable": true, "description": "Contract probation end date." }, "jobName": { "type": "string", "nullable": true, "description": "Job name of the employee." }, "status": { "description": "Status of the contrat.", "type": "string", "x-enum-name": "ContractStatusEnum", "enum": [ "ACTIVE", "ARCHIVED", "PENDING" ] }, "collaboratorId": { "type": "string", "description": "The id of the collaborator linked to the contract." } }, "required": [ "contractId", "companyId", "startDate", "jobName", "status", "collaboratorId" ] } ] }, { "type": "object", "properties": { "firstName": { "type": "string", "description": "Firstname of the employee. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true }, "lastName": { "type": "string", "description": "Lastname of the employee. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true }, "birthName": { "type": "string", "description": "Name given to the employee upon their birth. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true }, "birthDate": { "type": "string", "format": "date", "description": "Birth date of the employee. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true, "nullable": true }, "contactEmail": { "type": "string", "nullable": true, "description": "The contact email of the contract. This email is not guaranteed to be a real email or to belong to a real employee since it is not validated by PayFit. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true }, "address": { "type": "string", "nullable": true, "description": "The address of the contract. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true }, "city": { "type": "string", "nullable": true, "description": "The city address of the contract. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true }, "postalCode": { "type": "string", "nullable": true, "description": "The postal code address of the contract. This field is deprecated, you should use the information on the collaborator entity instead.", "deprecated": true } }, "required": [ "firstName", "lastName", "birthName", "birthDate" ] } ] } }, "meta": { "title": "meta", "type": "object", "additionalProperties": false, "properties": { "nextPageToken": { "type": "string", "nullable": true }, "count": { "type": "integer", "nullable": true } } } } }, "examples": { "contracts": { "summary": "An example of contracts", "value": { "meta": { "nextPageToken": "eyJsaW1pdCI6NTAsIm9mZnNldCI6NTB9", "count": 2 }, "contracts": [ { "firstName": "Alice", "lastName": "Dupond", "birthName": "Martin", "birthDate": "1987-04-14", "summary": "An example of Alice's contract fr", "value": [ { "statutConventionnelDsn": "04", "natureContratDsn": "08", "motifRuptureDeContratDsn": null, "idcc": "0413", "healthInsuranceContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d36" ], "providentFundContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d37" ], "summary": "An example of Alice's contract", "value": { "contractId": "5b59e7b282ddef55f860d322", "companyId": "5b59e7b182ddef55f860d311", "collaboratorId": "6fe3a703-89f5-414d-8190-88f0d80435a3", "jobName": "Designer", "startDate": "2018-07-12", "endDate": null, "probationEndDate": null, "status": "ACTIVE", "standardWeeklyHours": 35, "fullTimeEquivalent": 1, "isFullTime": true } } ] }, { "firstName": "Bob", "lastName": "Martin", "birthName": "Dupond", "birthDate": "1990-01-01", "summary": "An example of Bob's contract fr", "value": [ { "statutConventionnelDsn": "01", "natureContratDsn": "10", "motifRuptureDeContratDsn": "998", "idcc": "0413", "healthInsuranceContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d36" ], "providentFundContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d37" ], "summary": "An example of Bob's contract", "value": { "contractId": "5b59e7b282ddef55f860d325", "companyId": "5b59e7b182ddef55f860d311", "collaboratorId": "6fe3a703-89f5-414d-8190-88f0d80435a3", "jobName": "Architect", "startDate": "2017-12-21", "status": "ACTIVE", "endDate": "2020-07-06", "probationEndDate": "2020-07-06", "standardWeeklyHours": null, "fullTimeEquivalent": null, "isFullTime": null } } ] } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 400, "error": "Bad request", "details": "Field \"id\" is required." } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 401, "error": "Unauthorized" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 403, "error": "Forbidden action", "details": "Missing scope \"contracts:read\"." } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 404, "error": "Ressource not found", "details": "The provided id is wrong" } } } } } } }, "security": [ { "partner-api-oauth": [ "contracts:read" ] } ] } } }, "components": { "securitySchemes": { "partner-api-oauth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://oauth.payfit.com/authorize", "tokenUrl": "https://oauth.payfit.com/token", "scopes": { "contracts:read": "Allow to read contracts information", "collaborators:contracts:write": "Allow to create contracts on a collaborator", "contracts:payslips:read": "Allow to read payslips", "contracts:time-information:read": "Allow to read time related information of contracts", "pension:read": "Allow to read pension documents", "collaborators:read": "Read general information of collaborators.", "collaborators:write": "Allow to create collaborators.", "collaborators:contracts:read": "Read contract information of collaborators.", "collaborators:management:read": "Read information about organisation and management.", "collaborators:meal-vouchers:read": "Read meal vouchers information of collaborators.", "collaborators:personal:read": "Read personal data of collaborators.", "collaborators:social-security:read": "Read the social security identifiers of collaborators.", "collaborators:legal-identity:read": "Read the legal identity information of collaborators.", "collaborators:bank-info:read": "Allow to read the bank info of collaborators.", "accounting:read": "Allow to read company accounting information", "payment-files:read": "Allow to read company payment file information", "time:read": "Allow to read time data", "time:write": "Allow to write time data", "health-insurance:read": "Allow to read health insurance contracts", "health-insurance:write": "Allow to write health insurance contracts" } } } } } }, "tags": [ { "name": "Contract" } ] } ```