Skip to content
SegmentationAPI

List jobs for the authenticated account

GET
/v1/jobs
curl --request GET \
  --url 'https://api.segmentationapi.com/v1/jobs?limit=25&mode=single&status=queued' \
  --header 'Authorization: Bearer <token>'

List async segmentation jobs for the authenticated account.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

Maximum number of jobs to return.

nextToken
string

Opaque cursor for the next page of results.

jobId
string

Return the matching job identifier, if it belongs to the account.

mode
string
Allowed values: single batch video

Filter jobs by processing mode.

status
string
Allowed values: queued processing success failed

Filter jobs by status.

Responses

Section titled “Responses”

200

Section titled “200”

Paginated job summaries

Media typeapplication/json
object
items
required
Array<object>
object
jobId
required
string
type
required
string
Allowed values: image video
processingMode
required
string
Allowed values: single batch video
totalItems
required
integer
status
required
string
Allowed values: queued processing success failed
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
error
string
nullable
nextToken
required
string
nullable
Examples
Exampledefault
{
  "items": [
    {
      "jobId": "job-abc-987",
      "type": "image",
      "processingMode": "batch",
      "status": "processing",
      "totalItems": 2,
      "createdAt": "2026-03-07T12:00:00Z",
      "updatedAt": "2026-03-07T12:01:00Z"
    }
  ],
  "nextToken": "eyJvZmZzZXQiOjIwfQ=="
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}

401

Section titled “401”

Authentication is missing, invalid, or expired

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
error
required
string
message
string
remainingTokens
integer
requestedTokens
integer
>= 1
expiresAt
string format: date-time
activeJobId
string
upgradeUrl
string format: uri
retryAfterSeconds
integer
>= 1
Examplegenerated
{
  "error": "example",
  "message": "example",
  "remainingTokens": 1,
  "requestedTokens": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "activeJobId": "example",
  "upgradeUrl": "https://example.com",
  "retryAfterSeconds": 1
}