StoreBay Developers
Crm

List tasks

GET
/tasks

Authorization

AuthorizationBearer <token>

Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.

In: header

Query Parameters

cursor?string

Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.

limit?integer

Page size. Values above the maximum are clamped.

Range1 <= value <= 100
Default25
status?string

Filter by task status.

Value in

  • "open"
  • "in_progress"
  • "done"
  • "cancelled"
assigned_user_id?string

Filter by assignee.

Formatuuid
subject_type?string

Filter by polymorphic subject type (e.g. deal, contact, agreement).

subject_id?string

Filter by polymorphic subject id (pair with subject_type).

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/tasks"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "task",      "title": "string",      "description": "string",      "status": "open",      "priority": "low",      "due_at": "2019-08-24T14:15:22Z",      "assigned_user_id": "fb44a81f-f77a-4323-8a34-49b1af008bf9",      "subject_type": "string",      "subject_id": "80e197be-61ad-4068-b4ff-a483fb5c18f9",      "completed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "limit": 0,    "cursor": {      "next": "string",      "has_more": true    }  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "rate_limited",    "message": "Rate limit exceeded. Retry after 7s."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}