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

Rhumbix Batch Export API

Export Data from Rhumbix

Rhumbix Batch Export API is one of 3 APIs that Rhumbix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Batch Export. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

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

Requests are made against the base URL https://async-api.rhumbix.com.

3 operations 3 paths 8 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.1
Base URL
https://async-api.rhumbix.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Rhumbix Batch Export API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). An API key is passed in the header as x-api-key (RMBXApiAuthorizer).

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.

Batch Export 3

Export Data from Rhumbix

GET
/{company_key}/batch/workshift/export/{batch_key}/status
Workshift Batch Status
batchWorkshiftExportStatus 2 params → 200202
GET
/{company_key}/batch/workshift/export/{batch_key}/results
Workshift Batch Results
batchWorkshiftExportResults 2 params → 200
POST
/{company_key}/batch/workshift/export
Workshift Export Request
batchWorkshiftExport 2 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Employee (10 properties), WorkComponents (4 properties), CostCode (4 properties), Workshift (3 properties). Each schema is shown below with its type and property counts.

TimecardEntry
object
2 properties
Employee
object
10 properties 1 required
CostCode
object
4 properties
WorkComponents
object
4 properties
BatchKey
string
Workshift
object
3 properties
WorkshiftQuery
object
2 properties 2 required
BatchStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhumbix-batch-export-api-openapi.yml Raw ↑

Other APIs Rhumbix publishes across the network.

Rhumbix Batch Import API
Rhumbix CORS API