Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Goals

Search Goal Types

Search for the available Goal Types using filters and pagination parameters. <br>Note: Pagination parameters are currently accepted but not enforced. <br><br> Testing notes: <br> - Use the testing widget's Try It! option to test this endpoint.<br> - Use the Examples > Request Example option to see how to initiate body parameters.<br>

post/goals/goal-types/search

Request body

fieldsstring[] required

List of fields IDs to include in the response. Use the metadata endpoints to fetch the available fields.

limitinteger

Maximum number of results to return (Note: pagination parameters are currently accepted but not enforced).

cursorstring

Cursor for pagination (Note: pagination parameters are currently accepted but not enforced).

Response

Goal type object fields.

nextCursorstring nullable

Cursor for next page (null if no more pages)

errorsobject nullable

Error information if any