Skip to main content
GET
CLI

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required
Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

Query Parameters

limit
integer<int32>

Maximum number of results to return

cursor
string

Pagination cursor from previous response

agentId
string

Agent ID for filtering

Example:

"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y"

parentObjectiveId
string

Optional filters

state
enum<string>

Filter by state

Available options:
STATE_UNSPECIFIED,
STATE_PENDING,
STATE_RUNNING,
STATE_WAITING,
STATE_FAILED,
STATE_CANCELLED,
STATE_FINALIZED,
STATE_TIMED_OUT
profileId
string
Example:

"profile_01HXKD2E5NQM3T9AYWCFS0AP08"

sortOrder
string

Sort order for results (asc or desc by creation time)

includeInfo
boolean

When set to true you may use more of your alloted API rate-limit

agentScheduleId
string

Filter to objectives produced by a specific AgentSchedule. Accepts canonical as_… form or external_id: form.

labels
string

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

tenantId
string

Filter to objectives associated with a tenant. Accepts the canonical tenant_… form or the external_id:<value> form.

subjectId
string

Filter to objectives associated with a subject. Accepts the canonical subj_… form or the external_id:<value> form; the external_id form is scoped within a tenant and requires tenant_id to also be set.

widgetId
string

Filter to objectives whose conversation ran through a widget. Accepts the canonical wgt_… form or the external_id:<value> form.

widgetSessionId
string

Filter to objectives created by a specific widget session.

Response

OK

items
object[]
required
pagination
object

Page carries cursor-based pagination state. There is no total: the cursor walks the result set without ever counting it, and a count would cost a second query on every list.