Skip to main content
GET
Get a list of tasks.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

selected_date
enum<string>
default:created

Specifies on what date (task creation or latest status change) the date_from and date_to limits should operate on. Default is created.

Available options:
created,
latest_status_change,
cleared
date_from

Records with date or time stamps newer than this value, if specified.

date_to

Records with date or time stamps up to and including this value, if specified.

cleared
boolean

Only return records with the cleared flag set/unset, if specified.

status
enum<string>[]

Only return records matching any of the specified task status values, if specified.

Current state of a task.

  • pending: The task is waiting to be processed.
  • processing: The task is currently being processed.
  • waiting: The task is waiting for additional input.
  • completed: The task has completed processing.
  • failed: An error occurred while the task was being processed.
  • invalid: The data uploaded does not provide any information pertaining to the task to be performed.
  • deferred: The bulk processing task has been put into a deferred state due to high load
Available options:
pending,
processing,
waiting,
completed,
failed,
invalid,
deferred
order_by
enum<string>
default:created

Sort criteria to use for the query.

Available options:
created,
latest_status_change,
cleared,
name,
id,
external_id
offset
integer
default:0

Start offset to use for records returned.

Required range: x >= 0
length
integer
default:100

Max. number of matching records to return from offset.

Required range: 1 <= x <= 200
sort_ascending
boolean
default:false

If true, the sort order for the sort criteria is set to ascending. false or leaving this value unspecified will cause descending sort order to be used.

task_type
string[]

Only return records with specified task types, if specified.

Response

Successful Response

Response from getting a list of tasks.

count
integer
required

Total number of matching tasks.

offset
integer
required

Start offset within the sorted list of matching records for the data returned in this response.

tasks
TaskSummary · object[]
required

List of matching tasks, filtered and sorted by the criteria in the request.