Wellhub Jobs API
Endpoints for managing eligibility batch jobs. A job follows a lifecycle: Create → Add Items → Submit → Monitor.After submission, the job transitions through the following statuses:- `PENDING` — job has been submitted and is queued.- `VALIDATING` — intermediate state while items are being validated.- `SUCCEEDED` — all items processed successfully (terminal).- `SUCCEEDED_WITH_ERRORS` — job has been partially processed, with error entries that must be fixed (terminal). → **Call `GET /errors` to review failures.**- `REJECTED` — job was rejected due to validation issues (terminal). → **Call `GET /errors` to review failures.**- `INTERNAL_SERVER_ERROR` — a server-side error occurred during processing; it is recommended to try again (terminal). → **Retry job submission.**
Wellhub Jobs API is one of 4 APIs that Wellhub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes 6 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version v1.0.0.
Requests are made against a single base URL, https://api.clients.wellhub.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Wellhub Jobs API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (OAuth2).
OAuth2— Bearer token obtained from POST /oauth/token using the clientcredentials grant type.
Paths & Operations 6
Across 5 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Endpoints for managing eligibility batch jobs. A job follows a lifecycle: Create → Add Items → Submit → Monitor. After submission, the job transitions through the following status…
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are JobItemResponse (18 properties), CreateJobItem (14 properties), JobError (6 properties), JobStatusResponse (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Wellhub 3
Other APIs Wellhub publishes across the network.