Tasks

List tasks

Returns a paginated list of tasks. Tasks represent individual outreach activities (calls, emails, etc.) assigned to users.

filter[account][id] joins through the task's prospect. The updatedAt range is half-open: gte is inclusive, lt is exclusive.

get/tasks

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/tasks
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: tasks:read)

Query parameters

page[size]integer

Number of items per page (max 100)

page[after]string

Cursor for fetching the next page. Opaque token returned by the API in links.next; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

page[before]string

Cursor for fetching the previous page. Opaque token returned by the API in links.prev; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return 400 Bad Request.

filter[id]string

Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter".

filter[sequence][id]string uuid

Filter tasks belonging to a specific sequence

filter[sequenceStep][id]string uuid

Filter tasks tied to a specific sequence step

filter[prospect][id]string uuid

Filter tasks for a specific prospect

filter[account][id]string uuid

Filter tasks associated with a specific account. Joins through the task's prospect (Prospect.accountId).

filter[owner][id]string

Filter tasks assigned to a specific user

filter[action]string[]

Filter by action type (comma-separated). Valid values: call, manual_email, auto_email, manual_email_reply, auto_email_reply, basic_task, linkedin_connection_request, manual_linkedin_connection_request, manual_linkedin_message, automatic_linkedin_message, manual_sms, auto_sms

filter[status]string[]

Filter by status (comma-separated). Valid values: pending, ready, finished, skipped, failed

filter[priority]string[]

Filter by priority (comma-separated). Valid values: low, normal, high, urgent

filter[dueAt][gte]string date-time

Filter tasks due at or after this timestamp (ISO 8601)

filter[dueAt][lte]string date-time

Filter tasks due at or before this timestamp (ISO 8601)

filter[completed]'true' | 'false'

Filter by completion state. Valid values: true, false

filter[sequenceState][state]string[]

Filter by the state of the task's sequence state (comma-separated). Valid values: active, paused, finished, null. The sentinel null matches one-off tasks not associated with a sequence.

filter[updatedAt][gte]string date-time

Filter by minimum updatedAt (ISO 8601 datetime)

filter[updatedAt][lt]string date-time

Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)

includestring[]

Comma-separated relations to expand inline. Valid values: owner, prospect, sequence, sequenceState, sequenceStep. Max 3.

Response

Successful response

Example response

{
  "data": [
    {
      "id": "dd0e8400-e29b-41d4-a716-446655440050",
      "action": "call",
      "dueAt": "2026-03-19T23:26:21.536Z",
      "note": "Initial outreach call",
      "status": "ready",
      "priority": "normal",
      "owner": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "prospect": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "sequence": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "sequenceState": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "sequenceStep": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "_href": "/v1/sequences/550e8400-e29b-41d4-a716-446655440000"
      },
      "createdAt": "2026-03-18T10:00:00.000Z",
      "updatedAt": "2026-03-18T10:00:00.000Z"
    }
  ],
  "links": {
    "first": "/v1/sequences?page[size]=50",
    "next": "/v1/sequences?page[size]=50&page[after]=eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCIsInYiOjF9"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.