Skip to navigation

List jobs

View as Markdown

List the organization’s jobs, newest first.

Pass name to look up one job, since job names are unique within an organization; the list is then empty or holds that job. Archived jobs are left out unless archived is true.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

namestring or nullOptional
archivedbooleanOptionalDefaults to false

Response

OK
idstringformat: "uuid"

Pass this as job_id to the job execution tools.

namestring
archivedboolean
publish_statusenum

draft while the job is still being worked on; in_review once its author considers it ready for an admin to publish; published once it is ready for others to rely on. New jobs start as draft.

Allowed values:
descriptionstring or nullOptional
triggerobject or nullOptional
parameter_definitionslist of objects or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error