CHcharthop
goal

Get the configured questions (hydrated with text) for a goal's progress updates, by phase

Changed on
get/v1/org/{orgId}/goal/{goalId}/question

Request

Path parameters

orgIdstring required

Org identifier (either id or slug)

goalIdstring required

Goal id

Query parameters

phase'FIRST' | 'UPDATE' | 'DONE'

Only return questions for this phase (FIRST, UPDATE, DONE); omit for all phases

Response

successful operation

idstring required
phase'FIRST' | 'UPDATE' | 'DONE' required
requiredboolean
questionstring required
type'ADDRESS' | 'ALLOCATIONS' | 'AUDIO' | 'BOOLEAN' | 'COMP' | 'COMPOUND' | 'COMP_BAND' | 'CONTACTS' | 'CURRENCY' | 'DATE' | 'DECIMAL' | 'ELAPSED_DAYS' | 'ELAPSED_MONTHS' | 'ELAPSED_YEARS' | 'EMAIL' | 'ENUM' | 'ENUM_EXPR' | 'ENUM_MULTI' | 'ENUM_SCALE' | 'EXPR' | 'FILE' | 'GROUP' | 'GROUPS' | 'GROUP_ASSIGNMENTS' | 'GROUP_TYPE' | 'GROUP_POSITION_ASSIGNMENTS' | 'IMAGE' | 'INTEGER' | 'JOB' | 'JOB_CODE' | 'JOBS' | 'JOB_TIER' | 'LIST' | 'MAP' | 'MONEY' | 'NAME' | 'OBJECT' | 'PAY_INTERVAL' | 'PERCENT' | 'PERSON' | 'PERSONS' | 'PHONE' | 'STOCKGRANT' | 'STRING' | 'TABLE_REF' | 'TEXT' | 'TIMEOFF' | 'TIMESTAMP' | 'TRACKED_GROUP' | 'URL' | 'USER' | 'VARIABLE_COMP' | 'VARIABLE_COMPS' required
plural'SINGLE' | 'LIST' | 'SET' required

Example response

[
  {
    "id": "588f7ee98f138b19220041a7",
    "values": [
      {
        "id": "588f7ee98f138b19220041a7"
      }
    ],
    "options": {
      "groupTypeIds": [
        "588f7ee98f138b19220041a7"
      ]
    }
  }
]

Changes