List all goals

Automation goals. Read-only resource: POST, PUT and DELETE are not routed.

Query Params
int32

Number of goals to return.

int32

Number of goals to skip, for paging.

Return only goals whose name contains every space-separated word.

int32

Return only goals in this automation.

int32

Return only the goal held by this automation block.

string

Set to any non-empty value to add per-goal completed, entered and rate under meta.success, and to restrict results to goals with tracking enabled or at least one completion.

string

Set to any non-empty value to exclude goals whose automation block was deleted.

string

Order by success rate (ASC or DESC). Applies the same filter as with_success, but meta.success is only returned when with_success is also set.

string

Comma-separated relationships to sideload: automation, automationBlock, contactGoals.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json