Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Goals

Search Goals

Search for Goals using filters and pagination parameters. <br> <br>Pagination parameters are currently accepted but not enforced. <br>Multiple filters can be combined in a single request. All filters use AND logic (goals must match ALL specified filters). <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/goals/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).

Example request

{
  "filters": [
    {
      "fieldId": "status",
      "values": [
        "onTrack",
        "completed"
      ]
    }
  ]
}

Response

Goals details

nextCursorstring nullable

Cursor for next page (null if no more pages)

errorsobject nullable

Error information if any

Example response

{
  "items": [
    {
      "fields": {
        "id": {
          "value": 1
        },
        "title": {
          "value": "Sample Title 1"
        },
        "description": {
          "value": "Sample description"
        },
        "startDate": {
          "value": "2025-01-01"
        },
        "dueDate": {
          "value": "2025-10-10"
        },
        "typeId": {
          "value": 9292
        },
        "category": {
          "value": "Company"
        },
        "status": {
          "value": "completed"
        },
        "progress": {
          "value": 75
        },
        "owner": {
          "value": "123123123"
        },
        "alignedGoal": {
          "value": 9797
        },
        "hasKeyResults": {
          "value": true
        },
        "cycleId": {
          "value": 456
        },
        "weight": {
          "value": 25.5
        }
      }
    }
  ]
}