projects.jobs

Get Jobs

Get all Jobs in a Project.

get/{workspaceId}/projects/{projectName}/jobs

Request

  • Base URL
    https://app.intuned.io/api/v1/workspace
  • Auth
    API key in header x-api-key

Path parameters

workspaceIdstring uuid required

Your workspace ID. How to find it?

projectNamestring required

The name you assigned when creating the Project.

Response

List of jobs in the project.

idstring required

The ID of the job. Has to be a valid URL slug.

workspace_idstring uuid required

UUID of the workspace this job belongs to

project_idstring uuid required

UUID of the project this job belongs to

next_run_timestring nullable

The timestamp of the next scheduled job run. null if the job does not have a schedule.

last_run_timestring nullable

Timestamp of the last completed run

created_atstring required

Timestamp when the job was created

state'ACTIVE' | 'PAUSED' required

Current state of the job

schedule_idstring nullable

ID of the temporal schedule associated with this job

source'API' | 'CODE'

Source of the job - 'API' for jobs created via API/UI, 'CODE' for jobs defined in the jobs/ folder

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "configuration": {
      "retry": {
        "maximumAttempts": 3
      },
      "requestTimeout": 600,
      "proxy": "http://username:password@proxy.example.com:8080"
    },
    "payload": [
      {
        "parameters": {
          "param1": "value1",
          "param2": 42,
          "param3": true
        },
        "requestTimeout": 600,
        "retry": {
          "maximumAttempts": 3
        }
      }
    ],
    "sink": {
      "url": "https://example.com/webhook",
      "headers": {
        "Content-Type": "application/json",
        "Authorization": "Bearer token"
      },
      "apisToSend": [
        "api1",
        "api2"
      ]
    },
    "next_run_time": "2024-01-01T00:00:00Z",
    "last_run_time": "2024-01-01T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z",
    "auth_session": {
      "id": "auth-session-123"
    },
    "notifications": [
      {
        "url": "https://example.com/webhook",
        "headers": {
          "Content-Type": "application/json",
          "Authorization": "Bearer token"
        }
      }
    ],
    "schedule_id": "job-run-schedule-123",
    "source": "API"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.