--- updatedAt: 2026-06-29T09:41:37.000Z agentTools: projectIndex: https://developers.payfit.io/llms.txt --- # List all Health Insurance contracts 🇫🇷 Returns all Health Insurance contracts. \ **Required scopes**: *health-insurance: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}/health-insurance-contracts": { "get": { "operationId": "GET_healthInsuranceContracts", "summary": "List all Health Insurance contracts 🇫🇷", "description": "Returns all Health Insurance contracts.\n\\\n**Required scopes**: *health-insurance:read*", "tags": [ "Company" ], "parameters": [ { "in": "path", "name": "companyId", "schema": { "type": "string" }, "required": true, "description": "The id of the company" } ], "responses": { "200": { "description": "The health insurance contracts for a given company", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "contracts": { "type": "array", "items": { "type": "object", "properties": { "idContrat": { "type": "string", "description": "The generated PayFit id of the contract" }, "refContrat": { "type": "string", "description": "The reference of the contract", "nullable": true }, "codePopulation": { "type": "string", "nullable": true }, "codeOption": { "type": "string", "nullable": true }, "affiliatedContractIds": { "type": "array", "items": { "type": "string", "description": "The id of the contracts of employees of the company that are affiliated to the health insurance contract" } }, "modeCalculCotisation": { "type": "string", "nullable": true, "enum": [ "1", "2", "3", null ], "description": "The computation type of the health insurance contribution contract (1: Rate; 2: Fixed amount; 3: Rate and fixed amount)" }, "baseDeCotisation": { "type": "string", "nullable": true, "enum": [ "1", "2", "3", "4", "5", null ], "description": "The contribution base (1: Tiers; 2: Gross salary; 3: Tiers and gross salary; 4: PMSS; 5: Tiers, gross salary, and PMSS)" }, "tauxCotisationPatronale": { "type": "number", "nullable": true, "description": "The contribution rate supported by employer. Rate from 0 to 1, where 1 represent 100%" }, "tauxCotisationSalariale": { "type": "number", "nullable": true, "description": "The contribution rate supported by employee. Rate from 0 to 1, where 1 represent 100%" } }, "required": [ "idContrat", "refContrat", "codePopulation", "codeOption", "affiliatedContractIds", "modeCalculCotisation", "baseDeCotisation", "tauxCotisationPatronale", "tauxCotisationSalariale" ] } } }, "required": [ "contracts" ] }, "examples": { "healthInsuranceContracts": { "summary": "An example of health insurance contracts", "value": { "contracts": [ { "idContrat": "09977c3c-0ec0-417f-a871-f0e4fe02ed7d", "refContrat": "PCC123456789", "codePopulation": "15", "codeOption": "20", "affiliatedContractIds": [ "646ce15522ce2fd46c8ff724", "646ce15522ce2fd46c8ff725" ], "modeCalculCotisation": "1", "baseDeCotisation": "3", "tauxCotisationPatronale": 0.001, "tauxCotisationSalariale": 0.001 }, { "idContrat": "ea958903-63c9-46a1-9934-4912f6147da3", "refContrat": "XXX123456789", "codePopulation": "6", "codeOption": "14", "affiliatedContractIds": [ "646ce15522ce2fd46c8ff724", "646ce15522ce2fd46c8ff725" ], "modeCalculCotisation": "2", "baseDeCotisation": "1", "tauxCotisationPatronale": 0.003, "tauxCotisationSalariale": 0.002 } ] } } } } } }, "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": [ "health-insurance: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": "Company" } ] } ```