FUfullpath
tasks

List tasks

Returns a paginated list of tasks with optional filtering.

By default, only non-deleted tasks (where deleted_at is null) are returned. Use the trashed parameter to include or filter deleted tasks.

Additional fields can be included in the response using the embed parameter. Available embed options:

  • activities - Array of activities associated with the task
  • notes - Array of task notes
  • shopper - Shopper object associated with the task

Multiple embed options can be specified as a comma-separated list, e.g., embed=activities,notes,shopper.

get/dealerships/{dealershipId}/tasks

Request

Path parameters

dealershipIdinteger required

Dealership identifier (integer)

Query parameters

assigned_tointeger

Filter by assigned user ID

status'pending' | 'in_progress' | 'completed' | 'cancelled'

Filter by task status

priority'low' | 'medium' | 'high'

Filter by task priority

due_date_fromstring date

Filter tasks due from this date (YYYY-MM-DD)

due_date_tostring date

Filter tasks due until this date (YYYY-MM-DD)

trashed'with' | 'only' | 'without'

Filter tasks by deletion status. By default (or with trashed=without), only non-deleted tasks are returned.

  • without - Return only non-deleted tasks (default behavior)
  • with - Return all tasks including deleted ones
  • only - Return only deleted tasks
embedstring

Comma-separated list of fields to embed in the response. Available options: activities, notes, shopper

pageinteger

Page number (1-based)

per_pageinteger

Number of items per page

sortstring

Sort order (comma-separated field names with optional - prefix for descending)

Response

A paginated list of tasks

Changes

No recorded changes to this operation across all 2 revisions of this API.