Get a job

GET

/v1/jobs/{id}

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

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Responses

200

The job

Media typeapplication/json

object

id

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

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

404

Resource not found

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}