GET
List projects

Authorizations

Authorization
string
header
required

A token from POST /token/create, made with your API key pair.

Query Parameters

page
integer
default:1

The page, from 1; below 1 is a 422.

Required range: x >= 1
perPage
integer
default:25

Projects a page.

Required range: 1 <= x <= 100
name
string

Only the projects named exactly this, case included. Use it to find a project before creating it again.

Only the projects whose name contains this, ignoring case.

status
enum<string>

Only the projects in this state: running (its processing service is up), stopped, or error (its last start failed, or its service stopped working); or by what their files reached, as files last counted them: completed — stopped, nothing left to do (every file done or failed) and at least one done; failed — in error, or stopped with nothing left to do and no file done.

Available options:
running,
stopped,
error,
completed,
failed

Response

OK

data
object[]
required

Absolute URLs that keep the request’s filters and perPage.

meta
object
required

snake_case, the one exception to the API’s camelCase.