Skip to main content
GET
/
v1
/
tasks
List tasks
curl --request GET \
  --url https://api.shingleai.com/v1/tasks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T09:00:00Z",
      "updatedAt": "2024-01-15T14:30:00Z",
      "deletedAt": null,
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Review Q4 budget proposal",
      "description": "Complete the quarterly budget review and submit recommendations",
      "category": "review",
      "importance": "high",
      "urgency": "medium",
      "status": "todo",
      "dueDate": "2024-12-31T23:59:59Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdByAgent": false,
      "messageId": "550e8400-e29b-41d4-a716-446655440002",
      "contactId": "550e8400-e29b-41d4-a716-446655440003",
      "metadata": {
        "priority": "high",
        "source": "email"
      },
      "assignees": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440001",
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2024-01-15T10:30:00Z",
          "updatedAt": "2024-01-15T10:30:00Z"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Query Parameters

limit
integer
default:10

Maximum number of results to return

Required range: 1 <= x <= 100
Example:

10

offset
integer | null
default:0

Number of results to skip

Required range: x >= 0
Example:

0

sort
enum<string>
default:desc

Sort order by creation date

Available options:
asc,
desc
Example:

"desc"

status
enum<string>

Filter by task status

Available options:
backlog,
todo,
in_progress,
in_review,
done,
cancelled
Example:

"todo"

category
enum<string>

Filter by task category

Available options:
bug_fix,
documentation,
feature_request,
meeting,
other,
planning,
research,
review
Example:

"bug_fix"

urgency
enum<string>

Filter by urgency level

Available options:
low,
medium,
high
Example:

"high"

importance
enum<string>

Filter by importance level

Available options:
low,
medium,
high
Example:

"high"

assigneeId
string<uuid>

Filter by assigned user ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

contactId
string<uuid>

Filter by linked contact ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

messageId
string<uuid>

Filter by linked message ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

dueBefore
string<date-time>

Filter tasks due before this date (ISO 8601)

Example:

"2024-12-31T23:59:59Z"

dueAfter
string<date-time>

Filter tasks due after this date (ISO 8601)

Example:

"2024-01-01T00:00:00Z"

Response

List of tasks with pagination metadata

data
object[]
required
meta
object