Skip to main content
GET
/
v1
/
jobs
List Jobs
curl --request GET \
  --url https://sdk.nimbleway.com/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>",
      "agent_name": "<string>",
      "description": "<string>",
      "schedule": {
        "cron": "<string>",
        "enabled": true
      },
      "inputs": {
        "file_path": "<string>",
        "data": [
          {}
        ]
      },
      "destination": {
        "path": "<string>",
        "format": "parquet"
      },
      "last_run_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string | null

Search by name or display name

agent_name
string | null

Filter by agent name

page
integer
default:1
Required range: x >= 1
per_page
integer
default:20
Required range: 1 <= x <= 200

Cookies

token
string | null

Response

Successful Response

A page of jobs.

items
Job · object[]
required

Jobs on this page.

total
integer
required

Total number of jobs matching the query.

page
integer
required

Current page number.

per_page
integer
required

Number of items per page.