Skip to main content
POST
/
v1
/
tasks
Create task
curl --request POST \
  --url https://api.shingleai.com/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Review Q4 budget",
  "description": "Complete budget review before end of quarter",
  "category": "review",
  "importance": "high",
  "urgency": "medium",
  "status": "todo",
  "dueDate": "2024-12-31T23:59:59Z",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "messageId": "123e4567-e89b-12d3-a456-426614174001",
  "metadata": {
    "priority": "high",
    "source": "email"
  }
}
'
{
  "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

Body

application/json
​
title
string
required
Required string length: 1 - 500
Example:

"Review Q4 budget"

​
description
string
required
Required string length: 1 - 10000
Example:

"Complete budget review before end of quarter"

​
category
enum<string> | null
Available options:
bug_fix,
documentation,
feature_request,
meeting,
other,
planning,
research,
review
Example:

"review"

​
importance
enum<string> | null
Available options:
low,
medium,
high
Example:

"high"

​
urgency
enum<string> | null
Available options:
low,
medium,
high
Example:

"medium"

​
status
enum<string>
default:todo
Available options:
backlog,
todo,
in_progress,
in_review,
done,
cancelled
Example:

"todo"

​
dueDate
string<date-time> | null
Example:

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

​
contactId
string<uuid> | null
Example:

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

​
messageId
string<uuid> | null
Example:

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

​
metadata
object
Example:
{ "priority": "high", "source": "email" }

Response

Task created successfully

​
data
object
required
​
meta
object