activity_group

Get Activity Groups

Get all activity groups for an assessment.

get/api/v1/assessments/{assessment_id}/activity_group/

Request

The document declares no server URL.
Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Path parameters

assessment_idstring uuid required

Query parameters

namestring nullable

activity_group_positioninteger nullable

sort_by'name' | 'activity_group_position' nullable

sort_order'asc' | 'desc' nullable

Response

Successful Response

namestring required

visibleboolean

idstring uuid required

deletedboolean required

is_defaultboolean required

activity_group_positioninteger required

Example response

[
  {
    "activity_group_position": 0,
    "deleted": false,
    "id": "00000000-0000-0000-0000-000000000000",
    "is_default": false,
    "name": "Example Activity Group",
    "visible": false
  }
]

Changes

No recorded changes to this operation across all 4 revisions of this API.