Skip to content

List all tasks

Request

Security
ApiKey
Path
orgIdstringrequired

Organization ID.

Example:acme-inc
projectIdstringrequired

Project ID.

Example:my-project
Query
afterstring

Use the endCursor as a value for the after parameter to get the next page.

Example:after=a25fgaksjf23la==
beforestring

Use the startCursor as a value for the before parameter to get the next page.

Example:before=bfg23aksjf23zb1==
sortstring

This list is currently not sortable by other properties. It is sorted by the id descending (-id) by default. To reverse the sort order, use id as the value.

Default:"-id"
filterstring

Filters the collection items. This field requires a special format.

For more information, see Using filter with collections.

Example:filter=status:approved,pending updatedAt:2020-01-01..2022-01-01
limitinteger, [ 1 .. 100 ]

Use to return a number of results per page. If there is more data, use in combination with after to page through the data.

Default:10
Headers
x-redocly-scout-versionstring

Scout version.

Example:1.0.0
curl -i -X GET \
  'https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/tasks?after=a25fgaksjf23la%3D%3D&before=bfg23aksjf23zb1%3D%3D&sort=-id&filter=status%3Aapproved%2Cpending%20updatedAt%3A2020-01-01..2022-01-01&limit=10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-redocly-scout-version: 1.0.0'

Responses

OK.

Bodyapplication/json
objectstringrequired
Value:"list"
pageobject(Page)required
itemsArray of objects, >= 0 items(Job)required
Response
{
  "object": "list",
  "page": {
    "endCursor": "string",
    "startCursor": "string",
    "hasNextPage": true,
    "hasPrevPage": true,
    "limit": 10,
    "total": 0
  },
  "items": [
    { … }
  ]
}