Skip to main content
GET
Get revision history for one goal

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

studentId
string
required

Student sourcedId

goalId
string
required

Goal sourcedId

Query Parameters

subject
string

Filter by subject

status
enum<string>

Filter by OneRoster lifecycle status captured in the revision

Available options:
active,
tobedeleted
goalStatus
enum<string>

Filter by goal status captured in the revision

Available options:
active,
completed,
cancelled
goalType
enum<string>

Filter by goal type captured in the revision

Available options:
minimum,
percentile,
grade_mastery,
x_factor,
course,
ap_readiness
order
enum<string>

Sort order. Defaults to desc for student history, asc for one goal.

Available options:
asc,
desc
limit
integer

Max revisions (1-100, default 50)

Required range: 1 <= x <= 100
offset
integer

Results offset (default 0)

Required range: x >= 0

Response

Goal history returned

studentId
string
required

Student sourcedId

revisions
object[]
required
totalCount
integer
required

Total matching revisions

Required range: x >= 0
goalId
string

Goal sourcedId when scoped to one goal