v2

latestOpenAPI 3.1.02026-07-2664759910.6 KB
external
external-v2

List Follow Ups

List follow-ups for the authenticated caller's assistant with cursor pagination. Results are ordered by order_by and return next_page when additional rows are available. Use the optional status, task_id, and project_id filters to narrow the result set.

get/v2/follow-ups

Query parameters

limitinteger nullable

Maximum number of follow-ups in this page. Default is 50; valid range is 1 to 100.

Maximum number of follow-ups in this page. Default is 50; valid range is 1 to 100.

pagestring nullable

Opaque cursor from a previous list response. Omit for the first page. IMPORTANT: Reuse with the same order_by, status, task_id, and project_id values.

Opaque cursor from a previous list response. Omit for the first page. IMPORTANT: Reuse with the same order_by, status, task_id, and project_id values.

order_by'created_at' | 'updated_at' | 'scheduled_for'

Sort key for pagination boundaries. Use scheduled_for (default) to view follow-ups by trigger time. Use updated_at for recency feeds, or created_at for creation-order views.

Sort key for pagination boundaries. Use scheduled_for (default) to view follow-ups by trigger time. Use updated_at for recency feeds, or created_at for creation-order views.

status'pending' | 'fired' | 'completed' | 'canceled'

Optional filter by follow-up status.

task_idstring uuid nullable

Optional filter to follow-ups associated with a single task.

Optional filter to follow-ups associated with a single task.

project_idstring uuid nullable

Optional filter to follow-ups associated with a single project.

Optional filter to follow-ups associated with a single project.

Response

OK

next_pagestring nullable

Opaque cursor for the next page of follow-up results. null when there are no more results.

request_idstring required

Identifier for this API request. Useful for tracing and support.

totalinteger required

Total number of matching follow-ups before pagination is applied.