GET
/
{env_id}
/
{flow_id}
/
{tenant}
/
jobs
Fetch jobs
curl --request GET \
  --url https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs \
  --header 'x-api-key: <api-key>'
[
  {
    "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",
    "state": {},
    "tap": "quickbooks:sandbox",
    "status": "ETL_FAILED",
    "message": "ETL error...",
    "last_updated": "2020-12-30T20:31:00.081282+00:00"
  }
]

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
env_id
string
required

ID of environment

​
flow_id
string
required

ID of flow

​
tenant
string
required

ID of tenant

Query Parameters

​
count
integer
default:5

Number of jobs to return (sorted chronologically)

​
scheduled
boolean

Query for scheduled jobs only

​
job_type
enum<string>

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

Available options:
read,
write
​
page
integer
default:1

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

​
from
string<date>

Start date filter (ISO 8601 format)

​
to
string<date>

End date filter (ISO 8601 format)

​
include_state
boolean
default:false

Include job state in response if true

​
include_export_details
boolean
default:true

Include export details in response if true

Response

200

​
job_id
string
Example:

"lmaEbA"

​
env_id
string
Example:

"dev.example-env.hotglue.xyz"

​
job_name
string
Example:

"test_job:_V-vgdlLN"

​
tenant
string
Example:

"default"

​
started_by
string
Example:

"default"

​
flow
string
Example:

"l8odS2mce"

​
s3_root
string
Example:

"default/flows/l8odS2mce/jobs/lmaEbA"

​
start_time
string
Example:

"2020-12-30T18:01:01.828266+00:00"

​
state
object
​
tap
string
Example:

"quickbooks:sandbox"

​
status
enum<string>
Available options:
JOB_CREATED,
DISCOVER_STARTED,
DISCOVER_FAILED,
SYNC_STARTED,
SYNC_FAILED,
SYNC_SUCCESS,
ETL_STARTED,
ETL_FAILED,
ETL_SUCCESS,
EXPORT_STARTED,
EXPORT_FAILED,
JOB_COMPLETED
Example:

"ETL_FAILED"

​
message
string
Example:

"ETL error..."

​
last_updated
string
Example:

"2020-12-30T20:31:00.081282+00:00"