Company

Get Company 🌍

Returns the basic information of the company.
Required scopes: None

get/companies/{companyId}

Request

Base URL
https://partner-api.payfit.com
Auth
OAuth 2
Authorization codehttps://oauth.payfit.com/authorize
Token URLhttps://oauth.payfit.com/token
TypeScript
https://skmtc.dev/payfit/apis/partner-api/docs/companies/:companyId/get.ts
A function with typed inputs. Its response is checked against the schema.

companyIdstring required

The id of the company

The fetched company

idstring required

Id of the company.

namestring required

Name of the company.

country'FR' | 'ES' | 'GB' required

Country of the company.

identificationNumberstring required

Identification number of the company (e.g. SIRET for France, CIF for Spain, ...).

addressstring required

The company's address

citystring required

The city of the company

postalCodestring required

The postal code of the company

nbActiveContractsinteger required

Number of current active contracts within the company.

No recorded changes to this operation across all 2 revisions of this API.