Skip to main content
GET
/
tasks
curl --request GET \
  --url 'http://localhost:2003/api/v1/tasks?page=1&limit=30' \
  --header 'x-api-key: <your-api-key>'

{
  "success": true,
  "data": [
    {
      "id": "task_123",
      "status": "active",
      "readable_name": "My Task"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 30
}

curl --request GET \
  --url 'http://localhost:2003/api/v1/tasks?page=1&limit=30' \
  --header 'x-api-key: <your-api-key>'

{
  "success": true,
  "data": [
    {
      "id": "task_123",
      "status": "active",
      "readable_name": "My Task"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 30
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer
default:1

Page number for pagination

Example:

1

​
limit
integer
default:30

Number of tasks per page (max: 30)

Required range: x <= 30
Example:

30

Response

200 - application/json

Successful response

​
success
boolean

Indicates if the request was successful

Example:

true

​
data
object[]

Array of task objects

​
total
integer

Total number of tasks

Example:

1

​
page
integer

Current page number

Example:

1

​
limit
integer

Number of tasks per page

Example:

30

​
error
string

Error message if the request failed