START HERE

Make your first request

Use this guide to move from authentication to a valid Get Job Details request, then open each endpoint guide for the full request and response details.

1 · AUTHENTICATE

Get an access token

Use the authentication flow for your workspace and send the token as a Bearer credential.

2 · CHOOSE

Open an endpoint guide

Returns a list of submitted export jobs. — Guide first request →

3 · INSPECT

Read the response

Check the status, content type, and documented response fields before processing results.

REQUEST SCHEMA

GET /v1/jobs
Endpoint guides explain URL parameters, headers, request bodies, and required values.

RESPONSE SCHEMA

Endpoint guides pair a response example with the generated technical schema so implementation and validation stay together.

API REFERENCE

Get Job Details

Monitor export jobs and retrieve their status and results.

2 endpointsRequires bearer tokenEndpoint tech specs below

ON THIS PAGE

Available endpoints How to use

Available endpoints

Choose an endpoint to view its request parameters, response schema, and examples.

get

Check status of a data export job

/v1/job/{jobId}

get

Returns a list of submitted export jobs.

/v1/jobs

How to use

Use the endpoint pages below for the technical request and response details. Authenticate with a bearer token and follow the requirements shown on each endpoint.

Endpoint details
Each card opens the generated endpoint reference, including parameters, request bodies, responses, and examples.