Skip to main content
GET
List Avatar jobs

Authorizations

X-App-ID
string
header
required

Your Spatius App ID.

X-API-Key
string
header
required

The API key bound to the App ID.

Query Parameters

statuses
enum<string>[]

Repeatable status filter. Only jobs in one of the given statuses are returned.

Lifecycle status of an Avatar creation job.

Available options:
queued,
processing,
succeeded,
failed
pagination.pageSize
integer<int32>
default:20

Maximum number of items to return. Defaults to 20; the maximum is 99. A value above 99 falls back to the default of 20 rather than being capped, so request at most 99.

Required range: 1 <= x <= 99
pagination.pageToken
string

Opaque token from the previous page's nextPageToken. Omit for the first page. Pass back exactly what the previous response returned rather than constructing a value. A token is only valid for the pagination.pageSize it was issued with; keep that value stable while paging, or start again from the first page.

Response

A page of Avatar creation jobs.

jobs
object[]
pagination
object