Skip to content

Get the API key's company

GET
/company
curl --request GET \
--url https://api.fleet.co/platform/v1/company \
--header 'Authorization: Bearer <token>'

Company

Media typeapplication/json
object
data
required
object
id
required
integer
name
required

Trade name shown in Cockpit

string
legal_name
required
string
nullable
registration_number
required

Company registration number for its country: SIREN in France, CRN in the UK, EIN in the US, etc.

string
nullable
country
required

Head office country, ISO 3166-1 alpha-2

string
nullable
currency
required

ISO 4217 currency of the head office country, used for catalog pricing and carts

string
nullable
acquisition_mode
required

LEASING: monthly lease. BUY: one-time purchase.

string
Allowed values: LEASING BUY
hrms_integration
required

The HR software connection, or null when none is connected. Connect one from Cockpit’s settings.

object
provider
required

HR software the company syncs employees from

string
Allowed values: GOOGLE HIBOB BAMBOOHR PERSONIO LUCCA FACTORIAL PAYFIT RIPPLING
status
required

SETUP_IN_PROGRESS is connected, but the first employee import is not confirmed yet

string
Allowed values: CONNECTED SETUP_IN_PROGRESS
last_synced_at
required

Last employee sync, ISO 8601

string
nullable

Example

{
"data": {
"country": "FR",
"currency": "EUR",
"acquisition_mode": "LEASING",
"hrms_integration": {
"provider": "GOOGLE",
"status": "CONNECTED"
}
}
}

Missing, invalid, or revoked API key

Media typetext/plain
string

Example

Unauthorized

Not found

Media typeapplication/json
object
error
required
string
Allowed values: COMPANY_NOT_FOUND

Example

{
"error": "COMPANY_NOT_FOUND"
}

Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.

Media typetext/plain
string

Example

Too many requests, please try again later.

Unexpected server error

Media typeapplication/json
object
error
required
string
Allowed values: INTERNAL_ERROR

Example

{
"error": "INTERNAL_ERROR"
}

Rate limiting is temporarily unavailable; retry with backoff

Media typeapplication/json
object
message
required
string

Example generated

{
"message": "example"
}