Skip to main content
GET
/
{workspaceId}
/
projects
/
{projectName}
/
jobs
/
{jobId}
getJob
import { IntunedClient } from "@intuned/client";

const client = new IntunedClient({
  workspaceId: "123e4567-e89b-12d3-a456-426614174000",
  apiKey: process.env["INTUNED_API_KEY"] ?? "",
});

async function run() {
  const result = await client.projects.jobs.one(
    "my-project",
    "my-sample-job",
);

  console.log(result);
}

run();
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "configuration": {
    "retry": {
      "maximumAttempts": 3
    },
    "maxConcurrentRequests": 13,
    "requestTimeout": 600,
    "maxRuns": 2,
    "proxy": "http://username:password@proxy.example.com:8080"
  },
  "created_at": "2024-01-01T00:00:00Z",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "sink": {
    "type": "webhook",
    "url": "https://example.com/webhook",
    "headers": {
      "Content-Type": "application/json",
      "Authorization": "Bearer token"
    },
    "skipOnFail": false,
    "apisToSend": [
      "api1",
      "api2"
    ]
  },
  "next_run_time": "2024-01-01T00:00:00Z",
  "last_run_time": "2024-01-01T00:00:00Z",
  "payload": [
    {
      "parameters": {
        "param1": "value1",
        "param2": 42,
        "param3": true
      },
      "apiName": "<string>",
      "requestTimeout": 600,
      "retry": {
        "maximumAttempts": 3
      }
    }
  ],
  "schedule": {
    "jitter": 1,
    "intervals": [
      {
        "every": 1
      }
    ],
    "calendars": [
      {
        "second": 29,
        "minute": 29,
        "hour": 11,
        "dayOfMonth": 16,
        "year": 5984,
        "comment": "<string>"
      }
    ]
  },
  "auth_session": {
    "id": "auth-session-123"
  },
  "proxy": "http://username:password@proxy.example.com:8080"
}

Authorizations

​
x-api-key
string
header
required

API Key used to authenticate your requests. How to create one.

Path Parameters

​
workspaceId
string<uuid>
required

Your workspace ID. How to find it?

​
projectName
string
required

The name you assigned when creating the Project.

​
jobId
string
required

The ID you assigned when creating the Job.

Response

Detailed information about a specific job

Detailed information about a specific job

​
id
string
required

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

Minimum string length: 1
Pattern: ^[a-zA-Z0-9\-_]+$
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
configuration
object
required

Job configuration settings

​
created_at
string
required

Timestamp when the job was created

Example:

"2024-01-01T00:00:00Z"

​
state
enum<string>
required

Current state of the job

Available options:
ACTIVE,
PAUSED
​
projectId
string<uuid>
required

UUID of the project this job belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
sink
Webhook Sink Configuration · object

Optional sink configuration for the job. Can be a webhook or S3 Compatible sink.

​
next_run_time
string | null

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

Example:

"2024-01-01T00:00:00Z"

​
last_run_time
string | null

Timestamp of the last completed run

Example:

"2024-01-01T00:00:00Z"

​
payload
object[]

Array of API calls to be executed

​
schedule
object

Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time.

​
auth_session
object

Authentication session information for the job

Example:
{ "id": "auth-session-123" }
​
proxy
string

Proxy URL if configured for the job

Example:

"http://username:password@proxy.example.com:8080"