--- updatedAt: 2026-06-29T09:41:37.000Z agentTools: projectIndex: https://developers.payfit.io/llms.txt --- # Get Company 🇫🇷 Returns the basic information of the company with french specific data. \ **Required scopes**: None # 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-fr/{companyId}": { "get": { "operationId": "GET_company_fr", "summary": "Get Company 🇫🇷", "description": "Returns the basic information of the company with french specific data.\n\\\n**Required scopes**: None", "tags": [ "Company" ], "parameters": [ { "in": "path", "name": "companyId", "schema": { "type": "string" }, "required": true, "description": "The id of the company" } ], "responses": { "200": { "description": "The french fetched company", "content": { "application/json": { "schema": { "title": "company-fr", "allOf": [ { "title": "company", "type": "object", "properties": { "id": { "type": "string", "description": "Id of the company." }, "name": { "type": "string", "description": "Name of the company." }, "country": { "type": "string", "x-enum-name": "CountryEnum", "enum": [ "FR", "ES", "GB" ], "description": "Country of the company." }, "identificationNumber": { "type": "string", "description": "Identification number of the company (e.g. SIRET for France, CIF for Spain, ...)." }, "address": { "type": "string", "description": "The company's address" }, "city": { "type": "string", "description": "The city of the company" }, "postalCode": { "type": "string", "description": "The postal code of the company" }, "nbActiveContracts": { "type": "integer", "description": "Number of current active contracts within the company." } }, "required": [ "id", "name", "country", "identificationNumber", "address", "city", "postalCode", "nbActiveContracts" ] }, { "type": "object", "properties": { "siren": { "type": "string", "deprecated": true, "description": "\"Système Identification Répertoire Entreprises\" of the company. Deprecated: use identificationNumber instead (first 9 characters)." }, "siret": { "type": "string", "deprecated": true, "description": "\"Système Identification Répertoire Etablissements\" of the company. Deprecated: use identificationNumber instead." }, "address": { "type": "string", "description": "The company's address" }, "city": { "type": "string", "description": "The city of the company" }, "postalCode": { "type": "string", "description": "The postal code of the company" }, "healthInsuranceProrationMethod": { "type": "string", "description": "The method to prorate the health insurance. This field is set only if the 'health-insurance:read' scope is set.", "enum": [ "WORKING_DAYS", "CALENDAR_DAYS", "THIRTY_DAYS", null ], "nullable": true, "x-enum-name": "HealthInsuranceProrationMethodEnum" } }, "required": [ "siren", "siret", "address", "city", "postalCode", "healthInsuranceProrationMethod" ] } ] }, "examples": { "companyFr": { "summary": "An example of french company", "value": { "id": "1234567899", "name": "Awesome company", "country": "FR", "nbActiveContracts": 12, "siret": "362 521 879 00034", "siren": "362 521 879", "address": "1 RUE DE SAINT PETERSBOURG", "city": "PARIS", "postalCode": "75018", "healthInsuranceProrationMethod": "WORKING_DAYS" } } } } } }, "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": [] } ] } } }, "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" } ] } ```