Get the API key's company
const url = 'https://api.fleet.co/platform/v1/company';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.fleet.co/platform/v1/company \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Company
object
object
Trade name shown in Cockpit
Company registration number for its country: SIREN in France, CRN in the UK, EIN in the US, etc.
Head office country, ISO 3166-1 alpha-2
ISO 4217 currency of the head office country, used for catalog pricing and carts
LEASING: monthly lease. BUY: one-time purchase.
The HR software connection, or null when none is connected. Connect one from Cockpit’s settings.
object
HR software the company syncs employees from
SETUP_IN_PROGRESS is connected, but the first employee import is not confirmed yet
Last employee sync, ISO 8601
Example
{ "data": { "country": "FR", "currency": "EUR", "acquisition_mode": "LEASING", "hrms_integration": { "provider": "GOOGLE", "status": "CONNECTED" } }}Missing, invalid, or revoked API key
Example
UnauthorizedNot found
object
Example
{ "error": "COMPANY_NOT_FOUND"}Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.
Example
Too many requests, please try again later.Unexpected server error
object
Example
{ "error": "INTERNAL_ERROR"}Rate limiting is temporarily unavailable; retry with backoff
object
Example generated
{ "message": "example"}
