Skip to main content
GET
/
api
/
v1
/
tasks
List tasks
curl --request GET \
  --url https://shelfforce.ai/api/v1/tasks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "placeId": "<string>",
      "placeName": "<string>",
      "assignedTo": "<string>",
      "dueDate": "2023-12-25",
      "complianceScore": 50,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Authorizations

​
Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Query Parameters

​
status
enum<string>

Filter by task status.

Available options:
pending,
in_progress,
completed,
cancelled
Example:

"pending"

​
placeId
string

Filter by place ID.

Example:

"pl_abc123"

​
assignedTo
string

Filter by user ID of the assignee.

Example:

"usr_qrs789"

​
projectId
string

Filter by project ID.

Example:

"prj_def456"

​
cursor
string

Opaque pagination cursor returned in the previous response.

​
limit
integer
default:25

Maximum number of items to return (default 25, max 100).

Required range: 1 <= x <= 100

Response

Paginated list of tasks.

​
data
object[]
required
​
pagination
object
required

Cursor-based pagination metadata.