v3

latestSwagger 2.02026-08-067506752.0 MB

goal

Find goals

get/v1/org/{orgId}/goal

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

personIdstring

Person id to filter goals by (owner or support)

groupIdstring

Group id to filter goals by

personFilterstring

Person filter

originalGoalIdstring

Original goal id to filter by

datestring date

Date to filter goals as-of

fromIdstring

Starting goal id for pagination

limitinteger

Number of results to return

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "goalTypeId": "588f7ee98f138b19220041a7",
      "parentGoalId": "588f7ee98f138b19220041a7",
      "originalGoalId": "588f7ee98f138b19220041a7",
      "relatedGoalIds": [
        "588f7ee98f138b19220041a7"
      ],
      "ownerPersonIds": [
        "588f7ee98f138b19220041a7"
      ],
      "supportPersonIds": [
        "588f7ee98f138b19220041a7"
      ],
      "groupIds": [
        "588f7ee98f138b19220041a7"
      ],
      "label": "Increase Revenue at least 10%",
      "shareAccess": [
        {
          "userId": "5887a7718f138b6a2a0041a7",
          "groupId": "5887a7718f138b6a2a0041a7",
          "fields": "name,image,title"
        }
      ],
      "progressUpdateConfig": {
        "schedule": "5 4 * * *"
      },
      "progressSummary": {
        "id": "588f7ee98f138b19220041a7",
        "actuals": [
          {
            "goalTargetId": "588f7ee98f138b19220041a7"
          }
        ],
        "forecasts": [
          {
            "goalTargetId": "588f7ee98f138b19220041a7"
          }
        ],
        "targetValues": [
          {
            "goalTargetId": "588f7ee98f138b19220041a7"
          }
        ]
      },
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "deleteId": "588f7ee98f138b19220041a7",
      "deleteBehalfId": "588f7ee98f138b19220041a7",
      "deleteAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "deleteAt": "2017-01-24T13:57:52Z"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}