Sign in

v2

latestOpenAPI 3.1.02026-07-31822441.6 KB

Fetch jobs

Returns a list of job details for a specified tenant. Note that this endpoint does not return raw data fetched in jobs.

get/{env_id}/{flow_id}/{tenant}/jobs

Path parameters

env_idstring required

ID of environment

flow_idstring required

ID of flow

tenantstring required

ID of tenant

Query parameters

countinteger

Number of jobs to return (sorted chronologically)

scheduledboolean

Query for scheduled jobs only

job_type'read' | 'write'

For V2 flows, define whether you fetch "read" or "write" type jobs

pageinteger

Pagination key used to fetch additional records. Defaults to page=1

fromstring date

Start date filter (ISO 8601 format)

tostring date

End date filter (ISO 8601 format)

include_stateboolean

Include job state in response if true

include_export_detailsboolean

Include export details in response if true

ignore_empty_jobsboolean

Ignore jobs with no records processed

sync_type'incremental_sync' | 'auto_sync' | 'full_sync' | 'real_time_sync'

Type of sync

Response

200

job_idstring
env_idstring
job_namestring
tenantstring
started_bystring
flowstring
s3_rootstring
start_timestring
stateobject
tapstring
status'JOB_CREATED' | 'DISCOVER_STARTED' | 'DISCOVER_FAILED' | 'SYNC_STARTED' | 'SYNC_FAILED' | 'SYNC_SUCCESS' | 'ETL_STARTED' | 'ETL_FAILED' | 'ETL_SUCCESS' | 'EXPORT_STARTED' | 'EXPORT_FAILED' | 'JOB_COMPLETED'
messagestring
last_updatedstring

Example response

[
  {
    "job_id": "lmaEbA",
    "env_id": "dev.example-env.hotglue.xyz",
    "job_name": "test_job:_V-vgdlLN",
    "tenant": "default",
    "started_by": "default",
    "flow": "l8odS2mce",
    "s3_root": "default/flows/l8odS2mce/jobs/lmaEbA",
    "start_time": "2020-12-30T18:01:01.828266+00:00",
    "tap": "quickbooks:sandbox",
    "status": "ETL_FAILED",
    "message": "ETL error...",
    "last_updated": "2020-12-30T20:31:00.081282+00:00"
  }
]