List jobs

GET

/v1/jobs

const url = 'https://shareout.site/v1/jobs';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shareout.site/v1/jobs \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

artifact_id

string

Jobs on one artifact. Its owner and editors see the shared schedules plus their own personal deliveries (Slack DM, own email, own linked Telegram); other people’s personal subscriptions stay hidden. Anyone else sees only their own jobs on it.

workspace_id

string

Without artifact_id, narrow your own jobs to one workspace.

Responses

200

Jobs

application/json

object

jobs

Array<object>

object

string

artifact_id

string

title

string

<= 200 characters

description

string

<= 1000 characters

action

string

Allowed values: email webhook slack discord http_get materialize telegram query_snapshot sheets_append

trigger_type

string

Allowed values: cron event

schedule

Cron expression (cron jobs only).

string

event_type

string

Allowed values: artifact.updated artifact.viewed comment.added email.received

config

object

enabled

boolean

next_run_at

ISO 8601; null for event-triggered jobs.

string format: date-time

nullable

last_run_at

string format: date-time

nullable

last_status

string

created_at

string format: date-time

updated_at

string format: date-time

nullable

Example

{
  "jobs": [
    {
      "action": "email",
      "trigger_type": "cron",
      "event_type": "artifact.updated"
    }
  ]
}