List tasks

Returns a paginated list of tasks. Deleted tasks are excluded. Read-only through the public API.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Query Parameters

pageinteger

Page number

Default: 1

limitinteger

Items per page (max 100)

Default: 20Maximum: 100

searchstring

Search term

statusstring

prioritystring

categorystring

assigneestring

Company user id the task is assigned to.

curl -X GET "https://clientsphere.io/api/v1/tasks?page=1&limit=20&search=%3Cstring%3E&status=%3Cstring%3E&priority=%3Cstring%3E&category=%3Cstring%3E&assignee=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Paginated list of tasks

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "title": "string",
      "description": "string",
      "priority": "high",
      "status": "in_progress",
      "type": "string",
      "category": "string",
      "tags": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "startDate": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z",
      "estimatedHours": 0,
      "actualHours": 0,
      "opportunityId": "3d9795f2-7722-4e1d-b41e-0c5d0c24a902",
      "ticketId": "e3e3e8ea-b02a-4536-85a2-a9c90f4ee74f",
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "assignedTo": 0,
      "createdBy": 0,
      "parentTaskId": "2506db93-67fe-4ab8-a809-f4aa6ed8a0f4",
      "dependsOn": "5154f74b-7d03-4d11-a3f2-045b7c084781",
      "recurringPattern": "string",
      "nextRecurringDate": "2019-08-24T14:15:22Z",
      "isRecurring": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 137,
      "totalPages": 7
    }
  }
}

List tasks

Authorization

Query Parameters

Response

TypeScript