Jobs

List jobs

get
Authorizations
Path parameters
workspace_idstring · uuidRequired
Query parameters
connector_nameanyOptional
data_sourceanyOptional
is_activebooleanOptional
nameanyOptional
orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

schema_nameanyOptional
Responses
200Success
application/json
get
GET /developers/workspaces/{workspace_id}/jobs/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 50,
  "next_page": 3,
  "previous_page": 1,
  "page_size": 10,
  "total_pages": 5,
  "current_page": 2,
  "results": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "_created_at": "2025-07-03T11:48:41.114Z",
      "_updated_at": "2025-07-03T11:48:41.114Z",
      "data_source": "text",
      "connector_name": "text",
      "schema_name": "text",
      "name": "text",
      "is_active": true
    }
  ]
}

Cancel job execution

delete
Authorizations
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Responses
204
No response body
delete
DELETE /developers/workspaces/{workspace_id}/jobs/{_id}/cancel/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content

Trigger job execution

post
Authorizations
Path parameters
_idstring · uuidRequired
workspace_idstring · uuidRequired
Query parameters
force_full_refreshbooleanOptional

Whether to force a full refresh on partial jobs.

Default: false
Responses
201
No response body
post
POST /developers/workspaces/{workspace_id}/jobs/{_id}/run/ HTTP/1.1
Host: api.erathos.com
Authorization: YOUR_API_KEY
Accept: */*
201

No response body

No content

PreviousAPI ReferenceNextOrchestration

Last updated