AnsweredAssumed Answered

REST - How to retrieve Enrollment Term "overrides"?

Question asked by Kurt Faulknerloser on Apr 11, 2017
Latest reply on Apr 14, 2017 by Kurt Faulknerloser

Hello,

 

Using the REST API, I've been successful in creating Enrollment Terms with overrides dates for "StudentEnrollment", "TeacherEnrollment", "TaEnrollment", and "DesignerEnrollment".  However, I've been unable to list the override data for Enrollment Terms.

 

The API states that the endpoint should look like this:  

https://<canvas>/api/v1/accounts/1/terms?include[]=overrides

and result in a listing like this:

{"enrollment_terms": [{       
   "id": 1,      
   "name": "Fall 20X6"      
   "start_at": "2026-08-31T20:00:00Z",      
   "end_at": "2026-12-20T20:00:00Z",      
   "created_at": "2025-01-02T03:43:11Z",      
   "workflow_state": "active",      
   "grading_period_group_id": 1,      
   "sis_term_id": null,      
   "overrides": {        
      "StudentEnrollment": {          
      "start_at": "2026-09-03T20:00:00Z",          
      "end_at": "2026-12-19T20:00:00Z"        
   },        
   "TeacherEnrollment": {          
      "start_at": null,          
      "end_at": "2026-12-30T20:00:00Z"        
   }}

}]}

However, I've been unable to get override data to appear.  When I send the request as formatted above, I get a response code = 200 & a list of all my Enrollment Terms, but none of them contain the override information.

 

The workflow_state[] request parameters seem to work as expected, so I'm left thinking that I must be missing something.

 

Thanks. 

Outcomes