Alladdin

Work in progress

Site en construction

الموقع قيد الإنشاء

Alladdin
GET

List all tasks

Scope: projects:projects.read https://api.alladdin.com/api/v2/tasks

Returns a paginated list of tasks.
Use status=open for the tasks still to do: not in a done status and not archived. Requests authenticated as a user also include the private projects that user is a member of; requests made with an API key list public projects only. Results are paginated with limit and cursor parameters. Default page size is 50, configurable up to 200.

Parameters

Query parameters

cursor string optional

Pagination cursor returned by the previous response. Omit to start from the first page.

limit integer optional = 50

Maximum number of items to return

status string optional

open: tasks not in a done status and not archived. done: tasks in a done status, archived ones included. Omit to list every task, archived ones included.

"open" "done"

Request

python
import requests

url = "https://api.alladdin.com/api/v2/tasks?cursor=value&limit=50&status=value"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

json
{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "project_id": "string",
      "list_id": "string",
      "name": "string",
      "description": "string",
      "index": "1",
      "status": "string",
      "status_name": "string",
      "priority": 0,
      "story_points": 0,
      "type": "string",
      "start_date": "string",
      "due_date": "string",
      "archived": false,
      "updated_at": "string",
      "created_at": "string",
      "assigned_to": [
        "string"
      ],
      "comments": [
        {}
      ],
      "featured": false,
      "reference": "string"
    }
  ],
  "has_more": false,
  "cursor": "string"
}

Success responses

200 List of tasks application/json object items[] object[] required id string required

Unique identifier

project_id string required

Project ID

list_id string | null required

List ID

name string required

Task name

description string required

Task description

index string required

Task index as a decimal string

status string required

Task status

status_name string | null required

The status's display name in the account, as the user sees it

priority integer required

Task priority

story_points number required

Story points

type string required

Task type

start_date string | null required

Start date, formatted according to the account's date settings

due_date string | null required

Due date, formatted according to the account's date settings

archived boolean required

Whether the task is archived

updated_at string | null required

Last update date in ISO 8601

created_at string | null required

Creation date in ISO 8601

assigned_to[] string[] required

Assigned user IDs

comments[] object[] required

Task comments

featured boolean required

Whether the task is featured

reference string required

Task reference

has_more boolean required

Whether there are more items on the next page

cursor string | null optional

Opaque cursor to pass as ?cursor= to fetch the next page. Null on the last page.

Error responses

400 Unknown status application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json

← PreviousUpdate a task →

Next →Get a task →