Get Started
Guides
Data Models
Authentication
Companies
Employees
Consumption Reports
Benefit Models
Payroll Cycles
curl --request GET \
--url https://pre-public-api.cobee.io/api/v3/companies \
--header 'Authorization: Bearer <token>'{
"companies": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"legalId": "<string>",
"legalName": "<string>",
"state": "active",
"contactEmail": "[email protected]",
"countryISO2Code": "<string>",
"deliveryAddress": {
"streetName": "<string>",
"streetNumber": "<string>",
"street": "<string>",
"postalCode": "<string>",
"province": "<string>",
"locality": "<string>",
"details": "<string>",
"district": "<string>"
},
"legalAddress": {
"streetName": "<string>",
"streetNumber": "<string>",
"street": "<string>",
"postalCode": "<string>",
"province": "<string>",
"locality": "<string>",
"details": "<string>",
"district": "<string>"
},
"corporationId": "<string>"
}
]
}List companies
curl --request GET \
--url https://pre-public-api.cobee.io/api/v3/companies \
--header 'Authorization: Bearer <token>'{
"companies": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"legalId": "<string>",
"legalName": "<string>",
"state": "active",
"contactEmail": "[email protected]",
"countryISO2Code": "<string>",
"deliveryAddress": {
"streetName": "<string>",
"streetNumber": "<string>",
"street": "<string>",
"postalCode": "<string>",
"province": "<string>",
"locality": "<string>",
"details": "<string>",
"district": "<string>"
},
"legalAddress": {
"streetName": "<string>",
"streetNumber": "<string>",
"street": "<string>",
"postalCode": "<string>",
"province": "<string>",
"locality": "<string>",
"details": "<string>",
"district": "<string>"
},
"corporationId": "<string>"
}
]
}Overview
Retrieve a list of the companies associated with the authenticated user.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Company CIF(s) to filter by. Can be a single CIF or multiple CIFs separated by commas
Company state to filter by
active Response
New response
Show child attributes
Show child attributes
The unique identifier of the company
The name of the company
The legal identification number of the company
The legal name of the company
The state of the company
active The contact email of the company
The two-letter ISO code of the company's country
Show child attributes
Show child attributes
The name of the street
The number of the building
Full formatted street address
The postal code of the address
The province or state of the address
The city or town of the address
Additional address details, if any
The district of the address, if applicable
Show child attributes
Show child attributes
The name of the street
The number of the building
Full formatted street address
The postal code of the address
The province or state of the address
The city or town of the address
Additional address details, if any
The district of the address, if applicable
The corporation ID if applicable, otherwise null