How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cobee by Pluxee Companies API

The Companies API from Cobee by Pluxee — 16 operation(s) for companies.

Cobee by Pluxee Companies API is one of 2 APIs that Cobee by Pluxee publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Companies. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 16 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://pre-public-api.cobee.io/api/v3, https://public-api.cobee.io/api/v3.

20 operations 16 paths 13 schemas 1 DELETE9 GET4 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://public-api.cobee.io/api/v3
Authentication
HTTP Bearer
License
MIT
Resource Areas
1

Authentication & Security 1

Cobee by Pluxee Companies API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 1 DELETE, 9 GET, 4 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Companies 20
PUT
/companies/{companyId}/employees/{employeeId}/limits
Set employee limits
2 params body → 200400401403
GET
/companies
Get all companies associated with the authenticated user
2 params → 200401
POST
/companies/{companyId}/employees
Register employee
1 param body → 201400401403404409500
GET
/companies/{companyId}/employees
Get employees
5 params → 200500
GET
/companies/{companyId}/employees/{employeeId}
Get employee
2 params → 200404500
DELETE
/companies/{companyId}/employees/{employeeId}
Remove employee
2 params → 204404500
PATCH
/companies/{companyId}/employees/{employeeId}
Update employee
2 params body → 204404500
PATCH
/companies/{companyId}/employees/{employeeId}/block
Block employee
2 params → 204404409500
PATCH
/companies/{companyId}/employees/{employeeId}/unblock
Unblock employee
2 params → 204404409500
PATCH
/companies/{companyId}/employees/{employeeId}/restore
Restore employee
2 params → 204404500
POST
/companies/{companyId}/employees/{employeeId}/invite
Send invitation email to an employee
2 params → 201404409422500
POST
/companies/{companyId}/employees/{employeeId}/migrate
Migrates an employee from one company to another within the same corporation
2 params body → 200201404422500
GET
/companies/{companyId}/payroll-cycles
Get the payroll cycles of a company. A null value on the end date means that the cycle is currently open.
1 param → 200404
POST
/companies/{companyId}/payroll-cycles/{payrollCycleId}
Close the current payroll cycle and open a new one.
2 params → 200400401404409500
GET
/companies/{companyId}/benefit-modelsdeprecated
Get all benefit models for a the company
1 param → 200401
GET
/companies/{companyId}/benefit-models/{benefitModelId}deprecated
Get the information of a benefit model
2 params → 200401404500
GET
/companies/{companyId}/consumptions
Find all employee consumptions for a specific company
6 params → 200404500
GET
/companies/{companyId}/employees/{employeeId}/consumptions
Find employee consumptions for a specific payroll cycle
6 params → 200404500
GET
/companies/{companyId}/payroll-cycles/{payrollCycleId}/employees/{employeeId}/consumptionsdeprecated
Find employee consumptions for a specific payroll cycle
3 params → 200404500
POST
/companies/{companyId}/payroll-cycles/{payrollCycleId}/employees/{employeeId}/consumptions
Creates a new employee consumption. Note: This endpoint is only available in the sandbox environment.
3 params body → 201400401404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Employee (16 properties), UpdateEmployeeRequest (14 properties), RegisterEmployeeRequest (14 properties), MigrateEmployeeRequest (13 properties). Each schema is shown below with its type and property counts.

MigrateEmployeeRequest
object
13 properties 9 required
RegisterEmployeeRequest
object
14 properties 9 required
BenefitBagConfig
object
5 properties
Address
object
8 properties 6 required
WorkdayConfiguration
object
4 properties 3 required
Company
object
10 properties 9 required
RegisterEmployeeResponse
object
1 property 1 required
UpdateEmployeeRequest
object
14 properties
Employee
object
16 properties 13 required
Error
object
2 properties 2 required
MonetaryAmount
object
2 properties 2 required
CreateConsumptionRequest
object
4 properties 4 required
BenefitModel
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cobee-companies-api-openapi.yml Raw ↑

Other APIs Cobee by Pluxee publishes across the network.

Cobee by Pluxee Oauth API
Where this information came from

This is an independent, third-party profile of Cobee by Pluxee Companies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.