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

Zylo Export Jobs API

Export Jobs allow you to export subscription data asynchronously. You first create an export job, then retrieve the results when the job is complete.

Zylo Export Jobs API is one of 4 APIs that Zylo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Export Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

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

Requests are made against a single base URL, https://api.zylo.com/v1.

2 operations 2 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.zylo.com/v1
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Zylo Export Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using your Token ID and Token Secret separated by a colon (TOKENID:TOKENSECRET). Tokens can be created in the Zylo Admin panel unde…

Paths & Operations 2

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

Export Jobs 2

Export Jobs allow you to export subscription data asynchronously. You first create an export job, then retrieve the results when the job is complete.

POST
/subscriptions/-/exportJobs
Zylo Create an export job
createExportJob body → 201401
GET
/subscriptions/-/exportJobs/{exportJobId}
Zylo Get an export job
getExportJob 1 param → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ExportJob (6 properties), Error (3 properties), ExportJobRequest (2 properties). Each schema is shown below with its type and property counts.

ExportJob
object
6 properties
Error
object
3 properties
ExportJobRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zylo-export-jobs-api-openapi.yml Raw ↑

Other APIs Zylo publishes across the network.

Zylo Applications API
Zylo Import Jobs API
Zylo Subscriptions API