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 Import API

Import Data into Rhumbix

Rhumbix Batch Import 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 Import. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 7 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.

4 operations 4 paths 7 schemas 2 GET2 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 Import 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 4

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

Batch Import 4

Import Data into Rhumbix

POST
/{company_key}/batch/employee/import
Employee Batch Data
batchEmployeeImport 2 params → 200
POST
/{company_key}/batch/project/import
Project Batch Data
batchProjectImport 2 params → 200
GET
/{company_key}/batch/employee/import/{batch_key}/status
Employee Import Status
batchEmployeeImportStatus 2 params → 200403
GET
/{company_key}/batch/project/import/{batch_key}/status
Project Import Status
batchProjectImportStatus 2 params → 200403

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Employee (10 properties), Project (6 properties), ImportStatus (2 properties), EmployeeImportStatus (1 property). Each schema is shown below with its type and property counts.

Project
object
6 properties 2 required
Employee
object
10 properties 1 required
ProjectImportStatus
object
1 property 1 required
EmployeeImportStatus
object
1 property 1 required
BatchKey
string
ImportStatus
object
2 properties 1 required
BatchStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Rhumbix publishes across the network.

Rhumbix Batch Export API
Rhumbix CORS API