Skip to main content
GET
/
jobs
List async jobs in the workspace
curl --request GET \
  --url https://api.scripe.io/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "job_a1b2c3d4e5f6g7h8",
      "type": "POST_GENERATION",
      "status": "QUEUED",
      "projectId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "progress": {
        "progress": 0.5,
        "updatedAt": "2023-11-07T05:31:56Z",
        "message": "<string>"
      },
      "result": {},
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "attemptCount": 1,
      "estimatedCompletionMs": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "next_cursor": "<string>",
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.scripe.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

Headers

​
Scripe-Api-Version
string

Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Example:

"2026-08-01"

Query Parameters

​
cursor
string

Opaque pagination cursor returned by the previous page.

​
limit
integer
default:50

Page size. Default 50, max 200.

Required range: 1 <= x <= 200
​
dateFrom
string<date-time>

ISO 8601 or YYYY-MM-DD lower bound (inclusive).

​
dateTo
string<date-time>

ISO 8601 or YYYY-MM-DD upper bound (inclusive).

​
type
string

Comma-separated job-type filter.

Example:

"POST_GENERATION,KB_INGEST_TEXT"

​
status
string

Comma-separated status filter.

Example:

"QUEUED,RUNNING,DONE"

Response

Page of jobs.

​
data
object[]
required
​
pagination
object
required