Skip to main content
GET
/
v1
/
jobs
/
{jobId}
/
status
Get job status
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/jobs/{jobId}/status \
  --header 'Authorization: Bearer <token>'
{
  "job_type": "refresh_schema",
  "job_id": "4e6953a9-a71b-4c0b-8b63-a9ea308f6aaf",
  "status": "RUNNING"
}
The response will contain one of the following statuses:
StatusDescription
RUNNINGJob is currently executing
COMPLETEDJob finished successfully
FAILEDJob failed
We recommend the following when polling:
  • Use a reasonable polling interval (2-5 seconds)
  • Avoid polling more frequently than once per second

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
jobId
string<uuid>
required

The job ID returned from an asynchronous operation such as Refresh schema

Response

Job status retrieved successfully

​
job_type
string

The type of job

Example:

"refresh_schema"

​
job_id
string<uuid>

The unique identifier of the job

​
status
enum<string>

Current status of the job

Available options:
RUNNING,
COMPLETED,
FAILED