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

RevenueBase Jobs API

The Jobs API from RevenueBase — 4 operation(s) for jobs.

RevenueBase Jobs API is one of 4 APIs that RevenueBase 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, a quickstart, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.revenuebase.ai.

4 operations 4 paths 5 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.revenuebase.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

RevenueBase Jobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-key (APIKeyHeader).

Paths & Operations 4

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

Jobs 4
GET
/v2/jobs
List active batch jobs
list_jobs_v2_jobs_get → 200
GET
/v2/jobs/{process_id}
Get batch job status
get_job_v2_jobs__process_id__get 1 param → 200422
POST
/v2/jobs/{process_id}/cancel
Cancel a batch job
cancel_job_v2_jobs__process_id__cancel_post 1 param → 200422
GET
/v2/jobs/{process_id}/download
Download batch job results
download_job_v2_jobs__process_id__download_get 1 param → 200422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ValidationError (5 properties), Process (5 properties), BatchEmailStatusResponse (4 properties), HTTPValidationError (1 property). Each schema is shown below with its type and property counts.

Process
object
5 properties 5 required
ValidationError
object
5 properties 3 required
QueuedProcessesResponse
object
1 property 1 required
HTTPValidationError
object
1 property
BatchEmailStatusResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revenuebase-jobs-api-openapi.yml Raw ↑

Other APIs RevenueBase publishes across the network.

RevenueBase Account API
RevenueBase Email API
RevenueBase Organization API