Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Quinyx Forecast Optimal Headcounts API

The Forecast Optimal Headcounts API from Quinyx — 3 operation(s) for forecast optimal headcounts.

Quinyx Forecast Optimal Headcounts API is one of 35 APIs that Quinyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Forecast Optimal Headcounts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 2 base URLs: https://api.quinyx.com, https://api-rc.quinyx.com.

3 operations 3 paths 8 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.eu.quinyx.com
Authentication
OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Quinyx Forecast Optimal Headcounts API declares 7 security schemes for authenticating requests. It supports OAuth 2.0 (employee_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (opening-hours_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (organisation_OAuth2ClientCredentials) using the clientCredentials flow, exposing 4 scopes. It supports OAuth 2.0 (rest-api-uaa_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule-availability_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (schedule_OAuth2ClientCredentials) using the clientCredentials flow. It supports OAuth 2.0 (statistics_OAuth2ClientCredentials) using the clientCredentials flow.

  • employee_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • opening-hours_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • organisation_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • rest-api-uaa_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule-availability_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • schedule_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication
  • statistics_OAuth2ClientCredentials — OAuth2 Client Credentials flow. See https://developer.quinyx.com/api/authentication

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Forecast Optimal Headcounts 3
POST
/v2/forecast-calculation/groups/{groupId}/optimal-headcounts/{optimalHeadcountId}
Calculate optimal headcount by id
calculateOptimalHeadcountsById 2 params body → 200
GET
/v2/forecast-calculation/groups/{groupId}/optimal-headcounts
Calculate optimal headcounts for group, excluding limit rules
calculateOptimalHeadcounts 3 params → 200
GET
/v2/forecast-settings/optimal-headcounts
Get all optimal headcounts for the customer
getOptimalHeadcounts → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are forecast-settings_OptimalHeadcount (12 properties), forecast-calculation_AggregatedBlock (6 properties), forecast-calculation_DatasetAggregatedBlock (4 properties), forecast-calculation_AggregatedBlockLocalTime (4 properties). Each schema is shown below with its type and property counts.

forecast-calculation_AggregatedBlock
object
6 properties
forecast-calculation_OptimalHeadcountDatasetIntegrationRequest
object
3 properties 3 required
forecast-calculation_CalculatedDatasetResponse
object
4 properties
forecast-calculation_DatasetAggregatedBlockLocalTime
object
4 properties
forecast-calculation_AggregatedBlockLocalTime
object
4 properties
forecast-calculation_DatasetAggregatedBlock
object
4 properties
forecast-calculation_OptimalHeadcountDatasetByGroupResponse
object
4 properties
forecast-settings_OptimalHeadcount
object
12 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quinyx-forecast-optimal-headcounts-api-openapi.yml Raw ↑

Other APIs Quinyx publishes across the network.

Quinyx Absence Schedules API
Quinyx Absence Types API
Quinyx Absences API
Quinyx Access Token API
Quinyx Agreements API
Quinyx AI Scheduled Headcount API
Quinyx Authentication API
Quinyx Collaboration Groups API
Quinyx Collaboration Groups Labels API
Quinyx Employee API
Quinyx Employees API
Quinyx Forecast Data API