Skip to content
ywork API

List tasks in a project

GET
/projects/{projectId}/tasks
curl --request GET \
  --url 'https://docs.ywork.dev/api/v1/projects/example/tasks?limit=20&status=open' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

Unique identifier of the project (e.g. prj_...).

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 100

Maximum number of items to return (1–100). Defaults to 20.

cursor
string

An opaque cursor returned as next_cursor from a previous page. Omit to fetch the first page.

status
string
Allowed values: open in_progress done archived

Filter tasks by status.

Responses

Section titled “Responses”

200

Section titled “200”

A paginated list of tasks.

Media typeapplication/json
object
object
required
string
Allowed value: list
data
required
Array
pagination
required
object
has_more
required
boolean
next_cursor
required
string | null
data
required
Array<object>
object
id
required
string
object
required
string
Allowed value: task
project_id
required
string
title
required
string
status
required
string
Allowed values: open in_progress done archived
assignee_id
string | null
due_at
string | null format: date-time
created_at
required
string format: date-time
updated_at
string format: date-time
Example
{
  "object": "list",
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJvIjoyMH0"
  },
  "data": [
    {
      "id": "tsk_5Qm9Wp1xTr",
      "object": "task",
      "project_id": "prj_8Hs2Kd0aZq",
      "title": "Ship the new landing page",
      "status": "open",
      "assignee_id": "usr_3Jk2mQ8zpL"
    }
  ]
}

401

Section titled “401”

No valid API key was provided.

Media typeapplication/json
object
error
required
object
type
required

A broad category for the error.

string
Allowed values: authentication_error invalid_request_error rate_limit_error api_error
code
required

A short machine-readable code for the specific error.

string
message
required

A human-readable description of the error.

string
request_id

A unique identifier for the request, useful for support.

string
Example
{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No API key provided. Send your key as a bearer token in the Authorization header.",
    "request_id": "req_9f2a1c7b4e"
  }
}

404

Section titled “404”

The requested resource does not exist.

Media typeapplication/json
object
error
required
object
type
required

A broad category for the error.

string
Allowed values: authentication_error invalid_request_error rate_limit_error api_error
code
required

A short machine-readable code for the specific error.

string
message
required

A human-readable description of the error.

string
request_id

A unique identifier for the request, useful for support.

string
Example
{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No such resource.",
    "request_id": "req_4b8e0d2a71"
  }
}