Skip to content
Tidepool API/Task API/
/
List Tasks

List Tasks

Request

Returns list of tasks. The list can be filtered with the name, type, or state query parameters. It can also be paginated with the page and size query parameters.

Security
serverToken
Query
namestring(Task Name)

Task Name Filter. Filter by task name

typestring(Task Type)

Task Type Filter. Filter by task type

statestring(Task State)

Task State Filter. Filter by task state

Enum:"pending""running""failed""completed"
Example:state=running
pageinteger, (int32), >= 0(Page Number)read-only

Page number for pagination

Default:0
Example:page=0
sizeinteger, (int32), [ 1 .. 1000 ](Page Size)read-only

Page size for pagination

Default:100
Example:size=42
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/task.v1/v1/tasks?name=string&type=string&state=running&page=0&size=42' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Tasks

Bodyapplication/json
Array [
idstring, = 32 characters(Task ID)^[0-9a-f]{32}$
Example:"354b6adc10bc417eb715a8e7b21d6031"
namestring(Task Name)
typestring(Task Type)
priorityinteger, (int32), >= 0(Task Priority)
dataobject(Task Data)
availableTimestring, (date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example:"2017-02-06T02:37:46Z"
expirationTimestring, (date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example:"2017-02-06T02:37:46Z"
statestring(Task State)
Enum:"pending""running""failed""completed"
Example:"running"
errorstring(Task Error(s))
runTimestring, (date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example:"2017-02-06T02:37:46Z"
durationnumber, >= 0(Task Duration)
createdTimestring, (date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example:"2017-02-06T02:37:46Z"
modifiedTimestring, (date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example:"2017-02-06T02:37:46Z"
]
Response
[
  {
    "id": "354b6adc10bc417eb715a8e7b21d6031",
    "name": "string",
    "type": "string",
    "priority": 0,
    "data": {},
    "availableTime": "2017-02-06T02:37:46Z",
    "expirationTime": "2017-02-06T02:37:46Z",
    "state": "running",
    "error": "string",
    "runTime": "2017-02-06T02:37:46Z",
    "duration": 0,
    "createdTime": "2017-02-06T02:37:46Z",
    "modifiedTime": "2017-02-06T02:37:46Z"
  }
]