To-dos API

List to-dos with a specified set of fields

GET /api/v1/tasks

Use the fields parameter to control which attributes are returned for each to-do.

Parameters
NameDescription
page

Page number to return.

per_page

Number of records to return per page.

fields

Comma-separated list of fields to include for each to-do. Use * to include all default fields. When omitted, each to-do is returned in a stubbed form containing only a minimal set of fields (id, name, due_date, status, and created_at). Supported fields: id, name, due_date, status, created_at, body, position, updated_at, product_id, assigned_to_users, assigned_to_products, created_by_user, attachments, url, resource, comments_count, comments, custom_fields, and taskable. Some fields (for example comments) are only returned when named explicitly and are not included by *.

Example request

GET /api/v1/tasks?page=1&per_page=30&fields=name%2Cbody

Example CURL command

curl -g "https://company.aha.io/api/v1/tasks?page=1&per_page=30&fields=name%2Cbody" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body