Skip to content
Skip to Content
Docs
Studio

List Jobs

List the organization's jobs, newest first, one summary per job. Filter by kind, state or subject_id. Read one job with getJob for its items.

The filters are applied after each page is read, so a filtered page can return fewer than limit jobs, possibly zero, even when more matches exist further in. Keep paging with meta.cursor while meta.has_more is true.

GET
/studio/jobs

Query Parameters

limit?Limit

Most jobs to return (1-50).

Range1 <= value <= 50
Default20
cursor?|

Opaque cursor from a previous response's meta.cursor. Omit on the first page; pass back verbatim for the next.

kind?|

Only jobs of this kind.

state?|

Only jobs in this state.

subject_id?|

Only jobs working on this resource id.

Response Body

Successful Response

application/json
  1. response

Response for the list-jobs endpoint.

data*array<>
meta*

Paginated response metadata.

Example Request
curl -X GET 'https://api.bettermenu.live/studio/jobs'
Example Response
{  "data": [    {      "id": "string",      "kind": "custom_ingredient.pin_drift_scan",      "subject": {        "type": "custom_ingredient",        "id": "string"      },      "state": "queued",      "stalled": true,      "progress": {        "total": 0,        "done": 0,        "failed": 0,        "skipped": 0      },      "result": {},      "last_error": {        "code": "string",        "detail": ""      },      "created_by": {        "type": "string",        "id": "string"      },      "channel": "string",      "created_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "heartbeat_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z",      "redrives": 0    }  ],  "meta": {    "version": "string",    "request_id": "string",    "timestamp": "string",    "cursor": "string",    "has_more": true  }}

Recipe in, FDA-format Nutrition Facts out, with every version kept.

Start freeNo card needed.