List tasks

Returns a paginated list of tasks visible to the caller. PERSONAL tasks created by other users are excluded. ARCHIVED tasks are excluded unless include_archived=true is passed.

Filter parameters (all optional):

• status: Filter by task status — must be DRAFT, ACTIVE, COMPLETED, or ARCHIVED
• priority: Filter by priority — must be LOW, MEDIUM, or HIGH
• assigned_to_uuid: Filter tasks assigned to a specific user UUID
• created_by_uuid: Filter tasks created by a specific user UUID
• associated_entity_uuid: Filter tasks linked to a specific entity UUID
• search: Case-insensitive substring search on task title
• include_archived: Set to true to include ARCHIVED tasks (default: false)

Sort parameters:

• sort_by: created_at | updated_at | due_date | priority (default: updated_at)
• order: asc | desc (default: desc)

GET /v1/tasks

List tasks for the caller's tenant with optional filtering and pagination.

cURL

curl --request GET \
  --url https://production-api.joinrings.com/v1/tasks \
  --header 'x-api-key: <api-key>'

import requests

url = "https://production-api.joinrings.com/v1/tasks"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://production-api.joinrings.com/v1/tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production-api.joinrings.com/v1/tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production-api.joinrings.com/v1/tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/tasks")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production-api.joinrings.com/v1/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "id": "<string>",
      "assignments": [
        {
          "id": "<string>",
          "assigned_by_uuid": "<string>",
          "assigned_to_uuid": "<string>",
          "created_at": "<string>"
        }
      ],
      "content": {},
      "created_at": "<string>",
      "created_by_uuid": "<string>",
      "due_date": "<string>",
      "priority": "<string>",
      "status": "<string>",
      "title": "<string>",
      "updated_at": "<string>",
      "updated_by_uuid": "<string>",
      "visibility": "<string>"
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123
}

Authorizations

x-api-key · string · header · required

Query Parameters

page · integer · default: 1

Page number, 1-indexed. Clamped to >= 1.

per_page · integer · default: 50

Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).

status · enum<string> | null

Filter by task status. Must be one of: DRAFT, ACTIVE, COMPLETED, ARCHIVED. ARCHIVED tasks are excluded by default unless include_archived=true.

Available options: DRAFT, ACTIVE, COMPLETED, ARCHIVED

priority · enum<string> | null

Filter by task priority. Must be one of: LOW, MEDIUM, HIGH.

Available options: LOW, MEDIUM, HIGH

assigned_to_uuid · string | null

Filter tasks assigned to this internal user UUID.

created_by_uuid · string | null

Filter tasks created by this internal user UUID.

associated_entity_uuid · string | null

Filter tasks associated with this entity UUID (person, company, etc.).

search · string | null

Full-text search against task titles (case-insensitive substring).

include_archived · boolean · default: false

Include ARCHIVED tasks in results. Defaults to false.

sort_by · enum<string> | null · default: updated_at

Field to sort by. Valid values: created_at, updated_at, due_date, priority.

Available options: created_at, updated_at, due_date, priority

order · enum<string> · default: desc

Sort order. Valid values: asc (ascending), desc (descending).

Available options: asc, desc

Response

200 - application/json

Paginated list of tasks.

items · TaskResponse · object[] · required

Show child attributes

page · integer · required

per_page · integer · required

total · integer · required