Skip to content

job/all

Returns the list of jobs visible to the authenticated user.

Method and path

GET /job/all

Authentication

Authentication is required. See Authentication.

Permissions

Accessible to tier 1 and 2 users.

Admin users can retrieve all jobs.

Superusers receive only jobs linked to projects they can access.

Request headers

HeaderRequiredDescription
X-Api-Key or X_API_KEYyesAPI key.

Example request

bash
curl "$SIGNAL_API_BASE_URL/job/all" \
  -H "X-Api-Key: $SIGNAL_API_KEY"

Example response

json
{
  "data": [
    {
      "id": "<job_id>",
      "label": "Example Job",
      "type": "<job_type>",
      "freq": "<frequency_seconds>",
      "notes": "Example notes",
      "lastrun": "<unix_timestamp_or_null>",
      "active": "<boolean>",
      "limited": "<boolean>",
      "searchLang": "<language_code_or_null>",
      "search": "<search_string_or_json>",
      "options": {},
      "toRestart": "<boolean_or_null>",
      "efficiency": "<number_or_null>",
      "projects": ["<project_id>"]
    }
  ]
}

Response fields

FieldTypeDescription
dataarray<object>Jobs visible to the authenticated user.

Job object fields

FieldTypeDescription
idintegerJob identifier.
labelstringnull
typestringnull
freqintegernull
notesstringnull
lastrunintegernull
activebooleannull
limitedbooleanLimited-mode flag.
searchLangstringnull
searchstringnull
optionsobjectnull
toRestartbooleannull
efficiencynumbernull
projectsarray<integer>Linked project identifiers.

Notes

  • Some internal clients append an extra path segment, but the endpoint logic reads authentication from headers.

Doc rev.1.12.3 2026.05.08