Jobs

List jobs

Lists all in-progress and completed jobs for the authenticated user. Results are paginated.

GET
/jobs
AuthorizationBearer <token>

Token-based authentication using access tokens.

In: header

Query Parameters

page?Page

Page number.

Default1
per_page?Per Page

Items per page.

Default20
Range1 <= value <= 100
order?Order

Sort order.

Default"desc"
Value in"asc" | "desc"
status?Status

Filter jobs by status (optional).

Defaultnull
type?Type

Filter jobs by type (optional).

Defaultnull
started_after?Started After

Filter jobs started after this datetime (ISO 8601 format, optional).

Defaultnull
ended_before?Ended Before

Filter jobs ended before this datetime (ISO 8601 format, optional).

Defaultnull
ownership?Ownership

Filter by ownership: 'mine' for own jobs, 'shared' for group members' jobs.

Defaultnull

Response Body

Examples

curl -X GET "https://v2.api.piktid.com/jobs?page=1&per_page=20&order=asc"
{
  "jobs": [
    {
      "error_message": "string",
      "total_images": 0,
      "processed_images": 0,
      "created_at": "string",
      "updated_at": "string",
      "job_id": "string",
      "job_type": "string",
      "status": "string",
      "identity_code": "string",
      "identity_name": "string",
      "project_id": 0,
      "project_text": "string",
      "project_key": "string",
      "progress": 0,
      "should_post_process": true,
      "post_processing_status": "string",
      "processing_options": null
    }
  ],
  "pagination": {
    "page": 0,
    "per_page": 0,
    "total": 0,
    "pages": 0,
    "has_next": true,
    "has_prev": true
  }
}
{
  "error": "Invalid request",
  "detail": [
    {
      "field": null,
      "message": "string",
      "position": "query"
    }
  ]
}
Empty