# TimeEdit Documentation > This is the API documentation for TimeEdit, supporting institutions in achieving student-centric outcomes through Academic Operations, including Curriculum Management, Scheduling & Exams, Workload Planning and Evaluation. ## API Reference - [Welcome to TimeEdit's Developer Hub](https://developer.timeedit.com/reference/introduction.md) - [Getting Started](https://developer.timeedit.com/reference/getting-started.md) - [What API should I use?](https://developer.timeedit.com/reference/what-api-should-i-use.md) - [Authenticate Api Key](https://developer.timeedit.com/reference/post_organizations-organizationid-api-keys-authenticate.md): Authenticate using an api-key to receive an access token - [LIST Auth Configs](https://developer.timeedit.com/reference/get_auth-configs.md): Routes used by administration application - [CREATE Auth Config](https://developer.timeedit.com/reference/post_auth-configs.md): Routes used by administration application - [GET Auth Config](https://developer.timeedit.com/reference/get_auth-configs-authconfigid.md): Returns an authentication configuration - [PATCH Auth Config](https://developer.timeedit.com/reference/patch_auth-configs-authconfigid.md) - [DELETE Auth Config](https://developer.timeedit.com/reference/delete_auth-configs-authconfigid.md) - [LIST Availability Types](https://developer.timeedit.com/reference/get_availability-types.md): Routes used by administration application - [CREATE Availability Type](https://developer.timeedit.com/reference/post_availability-types.md): Routes used by administration application - [GET Availability](https://developer.timeedit.com/reference/get_availability-types-availabilitytypeid.md): Returns a availability type - [PATCH Availability Type](https://developer.timeedit.com/reference/patch_availability-types-availabilitytypeid.md) - [DELETE Availability Type](https://developer.timeedit.com/reference/delete_availability-types-availabilitytypeid.md) - [LIST limitations for Availability Types](https://developer.timeedit.com/reference/get_availability-types-limitations.md): Returns the existing limitations for availability type - [FIND Cancellations](https://developer.timeedit.com/reference/post_cancellations-find.md) - [GET Cancellation](https://developer.timeedit.com/reference/get_cancellations-cancellationid.md) - [FIND Cancellations History](https://developer.timeedit.com/reference/post_cancellations-history-find.md): Returns the history of a cancellation - [LIST Fields Relations](https://developer.timeedit.com/reference/get_field-relations.md) - [CREATE Field Relation](https://developer.timeedit.com/reference/post_field-relations.md) - [GET Field Relation](https://developer.timeedit.com/reference/get_field-relations-fieldrelationid.md): Returns a field relation - [PATCH Field Relation](https://developer.timeedit.com/reference/patch_field-relations-fieldrelationid.md) - [DELETE Field Relation](https://developer.timeedit.com/reference/delete_field-relations-fieldrelationid.md) - [LIST limitations for Field Relations](https://developer.timeedit.com/reference/get_field-relations-limitations.md): Returns the existing limitations for field relation - [FIND Fields](https://developer.timeedit.com/reference/post_fields-find.md) - [CREATE Field](https://developer.timeedit.com/reference/post_fields.md) - [GET Field](https://developer.timeedit.com/reference/get_fields-fieldid.md): Returns a field - [PATCH Field](https://developer.timeedit.com/reference/patch_fields-fieldid.md) - [DELETE Field](https://developer.timeedit.com/reference/delete_fields-fieldid.md) - [PATCH sort order for Fields](https://developer.timeedit.com/reference/patch_fields-sort-order.md) - [LIST limitations for Fields](https://developer.timeedit.com/reference/get_fields-limitations.md): Returns the existing limitations for field - [LIST Holidays](https://developer.timeedit.com/reference/get_holidays.md): Returns a list of holidays - [LIST Holiday Regions](https://developer.timeedit.com/reference/get_holidays-regions.md) - [CREATE Holiday Reservation](https://developer.timeedit.com/reference/post_holidays-reservations.md) - [LIST Languages](https://developer.timeedit.com/reference/get_languages.md) - [LIST Limitations](https://developer.timeedit.com/reference/get_limitations.md) - [LIST Member Types](https://developer.timeedit.com/reference/get_member-types.md): Routes used by administration application - [CREATE Member Type](https://developer.timeedit.com/reference/post_member-types.md): Routes used by administration application - [GET Member Type](https://developer.timeedit.com/reference/get_member-types-membertypeid.md): Returns a member type - [PATCH Member Type](https://developer.timeedit.com/reference/patch_member-types-membertypeid.md) - [DELETE Member Type](https://developer.timeedit.com/reference/delete_member-types-membertypeid.md) - [LIST limitations for Member Types](https://developer.timeedit.com/reference/get_member-types-limitations.md): Returns the existing limitations for member type - [FIND Objects](https://developer.timeedit.com/reference/post_objects-find.md) - [FIND Objects by Unique Field Value](https://developer.timeedit.com/reference/post_objects-find-by-unique-field-value.md): For a typeId and a fieldId, find objects with unique values for that field and type. The field must be unique. The field must also be searchable or an email field. - [BULK Upsert Objects](https://developer.timeedit.com/reference/post_objects-upsert.md) - [BULK Objects](https://developer.timeedit.com/reference/put_objects.md) - [BULK Validate Objects](https://developer.timeedit.com/reference/post_objects-validate.md) - [BULK DELETE Objects](https://developer.timeedit.com/reference/post_objects-delete.md) - [UPDATE Object members](https://developer.timeedit.com/reference/post_objects-update-members-by-type.md) - [UPDATE Object relations](https://developer.timeedit.com/reference/post_objects-update-relations-by-type.md) - [UPDATE Object optional relations](https://developer.timeedit.com/reference/post_objects-update-optional-relations-by-type.md) - [GET Object](https://developer.timeedit.com/reference/get_objects-objectid.md): Returns an object - [CREATE Object](https://developer.timeedit.com/reference/post_objects.md) - [PATCH Object](https://developer.timeedit.com/reference/patch_objects-objectid.md) - [DELETE Object](https://developer.timeedit.com/reference/delete_objects-objectid.md) - [FIND Objects History](https://developer.timeedit.com/reference/post_objects-history-find.md): Returns the history of an object, an event log of the changes that were made on the object. Note that the object history is only maintained for a limited time, which may vary depending on the type of the event. Also note that some events may refer to objects that have been removed, in which case any info regarding these removed objects may not be retrieved using the endpoints for objects. - [LIST limitations for Objects](https://developer.timeedit.com/reference/get_objects-limitations.md): Returns the existing limitations for objects - [FIND Organization Nodes](https://developer.timeedit.com/reference/post_organization-nodes-find.md) - [LIST Organization Nodes](https://developer.timeedit.com/reference/get_organization-nodes.md) - [CREATE Organization Node](https://developer.timeedit.com/reference/post_organization-nodes.md) - [GET Organization Node](https://developer.timeedit.com/reference/get_organization-nodes-nodeid.md): Returns a node - [PATCH Organization Node](https://developer.timeedit.com/reference/patch_organization-nodes-nodeid.md) - [DELETE Organization Node](https://developer.timeedit.com/reference/delete_organization-nodes-nodeid.md) - [GET Organization](https://developer.timeedit.com/reference/get_organizations-organizationid.md) - [LIST Padding Rules](https://developer.timeedit.com/reference/get_padding-rules.md): Routes used by administration application - [CREATE Padding Rule](https://developer.timeedit.com/reference/post_padding-rules.md): Routes used by administration application - [GET Padding Rule](https://developer.timeedit.com/reference/get_padding-rules-paddingruleid.md): Returns a padding rulee - [PATCH Padding Rule](https://developer.timeedit.com/reference/patch_padding-rules-paddingruleid.md) - [DELETE Padding Rule](https://developer.timeedit.com/reference/delete_padding-rules-paddingruleid.md) - [LIST limitations for Padding Rules](https://developer.timeedit.com/reference/get_padding-rules-limitations.md): Returns the existing limitations for padding rules - [LIST Padding Rules by Object Type](https://developer.timeedit.com/reference/get_padding-rules-objects-by-type-typeid.md): Returns the padding rules for objects - [LIST Period Headers](https://developer.timeedit.com/reference/get_period-headers.md) - [CREATE Period Header](https://developer.timeedit.com/reference/post_period-headers.md) - [GET Period Header](https://developer.timeedit.com/reference/get_period-headers-periodheaderid.md): Returns a Period-Header - [PATCH Period Header](https://developer.timeedit.com/reference/patch_period-headers-periodheaderid.md) - [DELETE Period Header](https://developer.timeedit.com/reference/delete_period-headers-periodheaderid.md) - [LIST Periods](https://developer.timeedit.com/reference/get_periods.md) - [CREATAE Period](https://developer.timeedit.com/reference/post_periods.md) - [GET Period](https://developer.timeedit.com/reference/get_periods-periodid.md): Returns a period - [PATCH Period](https://developer.timeedit.com/reference/patch_periods-periodid.md) - [DELETE Period](https://developer.timeedit.com/reference/delete_periods-periodid.md) - [LIST limitations for Periods](https://developer.timeedit.com/reference/get_periods-limitations.md): Returns the existing limitations for period - [LIST Scopes](https://developer.timeedit.com/reference/get_permissions.md) - [GET Scope](https://developer.timeedit.com/reference/get_permissions-permissionid.md) - [LIST Relation Types](https://developer.timeedit.com/reference/get_relation-types.md) - [CREATE Relation Type](https://developer.timeedit.com/reference/post_relation-types.md) - [GET Relation Type](https://developer.timeedit.com/reference/get_relation-types-relationtypeid.md): Returns a relation type - [PATCH Relation Type](https://developer.timeedit.com/reference/patch_relation-types-relationtypeid.md) - [DELETE Relation Type](https://developer.timeedit.com/reference/delete_relation-types-relationtypeid.md) - [LIST limitations for Relation Types](https://developer.timeedit.com/reference/get_relation-types-limitations.md): Returns the existing limitations for relation type - [FIND Reservation Modes](https://developer.timeedit.com/reference/post_reservation-modes-find.md) - [CREATE Reservation Mode](https://developer.timeedit.com/reference/post_reservation-modes.md) - [GET Reservation Mode](https://developer.timeedit.com/reference/get_reservation-modes-reservationmodeid.md): Returns a reservation mode - [PATCH Reservation Mode](https://developer.timeedit.com/reference/patch_reservation-modes-reservationmodeid.md) - [DELETE Reservation Mode](https://developer.timeedit.com/reference/delete_reservation-modes-reservationmodeid.md) - [LIST limitations for Reservation Modes](https://developer.timeedit.com/reference/get_reservation-modes-limitations.md): Returns the existing limitations for reservation mode - [PATCH sort order for Reservation Modes](https://developer.timeedit.com/reference/patch_reservation-modes-sort-order.md) - [LIST Reservation Templates](https://developer.timeedit.com/reference/get_reservation-templates.md) - [CREATE Reservation Template](https://developer.timeedit.com/reference/post_reservation-templates.md) - [GET Reservation Template](https://developer.timeedit.com/reference/get_reservation-templates-reservationtemplateid.md): Returns a reservation template - [PATCH Reservation Template](https://developer.timeedit.com/reference/patch_reservation-templates-reservationtemplateid.md) - [DELETE Reservation Template](https://developer.timeedit.com/reference/delete_reservation-templates-reservationtemplateid.md) - [Move Reservations to Reservation Template](https://developer.timeedit.com/reference/patch_reservation-templates-reservationtemplateid-move-reservations.md) - [Validate Reservations and move to trash](https://developer.timeedit.com/reference/patch_reservation-templates-reservationtemplateid-move-to-trash.md) - [LIST limitations for Reservation Templates](https://developer.timeedit.com/reference/get_reservation-templates-limitations.md): Returns the existing limitations for reservation template - [FIND Reservations](https://developer.timeedit.com/reference/post_reservations-find.md): Returns the reservations - [BULK Reservations](https://developer.timeedit.com/reference/put_reservations.md) - [BULK DELETE Reservations](https://developer.timeedit.com/reference/post_reservations-delete.md) - [CREATE Reservation](https://developer.timeedit.com/reference/post_reservations.md) - [GET Reservation](https://developer.timeedit.com/reference/get_reservations-reservationid.md): Returns a reservation - [PATCH Reservation](https://developer.timeedit.com/reference/patch_reservations-reservationid.md) - [DELETE Reservation](https://developer.timeedit.com/reference/delete_reservations-reservationid.md) - [FIND Reservations History](https://developer.timeedit.com/reference/post_reservations-history-find.md): Returns the history of a reservation - [LIST Roles](https://developer.timeedit.com/reference/get_roles.md) - [CREATE Role](https://developer.timeedit.com/reference/post_roles.md) - [GET Role](https://developer.timeedit.com/reference/get_roles-roleid.md): Returns a role - [PATCH Role](https://developer.timeedit.com/reference/patch_roles-roleid.md) - [DELETE Role](https://developer.timeedit.com/reference/delete_roles-roleid.md) - [LIST limitations for Roles](https://developer.timeedit.com/reference/get_roles-limitations.md): Returns the existing limitations for role - [LIST Time Rules](https://developer.timeedit.com/reference/get_time-rules.md) - [CREATE Time Rule](https://developer.timeedit.com/reference/post_time-rules.md) - [GET Time Rule](https://developer.timeedit.com/reference/get_time-rules-timeruleid.md): Returns a time rule - [PATCH Time Rule](https://developer.timeedit.com/reference/patch_time-rules-timeruleid.md) - [DELETE Time Rule](https://developer.timeedit.com/reference/delete_time-rules-timeruleid.md) - [LIST limitations for Time Rules](https://developer.timeedit.com/reference/get_time-rules-limitations.md): Returns the existing limitations for time rule - [FIND Types](https://developer.timeedit.com/reference/post_types-find.md) - [CREATE Type](https://developer.timeedit.com/reference/post_types.md) - [GET Type](https://developer.timeedit.com/reference/get_types-typeid.md): Returns a type - [PATCH Type](https://developer.timeedit.com/reference/patch_types-typeid.md) - [DELETE Type](https://developer.timeedit.com/reference/delete_types-typeid.md) - [LIST External Owners for Types](https://developer.timeedit.com/reference/get_types-external-owners.md): Returns the existing external owners for type - [LIST limitations for Types](https://developer.timeedit.com/reference/get_types-limitations.md): Returns the existing limitations for type - [LIST Users](https://developer.timeedit.com/reference/get_users.md) - [CREATE User](https://developer.timeedit.com/reference/post_users.md) - [GET User](https://developer.timeedit.com/reference/get_users-userid.md): Returns an user - [PATCH User](https://developer.timeedit.com/reference/patch_users-userid.md) - [DELETE User](https://developer.timeedit.com/reference/delete_users-userid.md) - [FIND Orders](https://developer.timeedit.com/reference/post_orders-find.md) - [CREATE Order](https://developer.timeedit.com/reference/post_orders.md) - [GET Order](https://developer.timeedit.com/reference/get_orders-orderid.md) - [PATCH Order](https://developer.timeedit.com/reference/patch_orders-orderid.md) - [DELETE Order](https://developer.timeedit.com/reference/delete_orders-orderid.md) - [/import/evaluation](https://developer.timeedit.com/reference/findevaluations.md): Find evaluations - [/import/evaluation](https://developer.timeedit.com/reference/saveevaluation.md): Save an evaluation - [/import/evaluation/{id}](https://developer.timeedit.com/reference/getevaluation.md): Get an evaluation based on ID - [/import/evaluation/{id}/archive](https://developer.timeedit.com/reference/getevaluation_1.md): Get an archived evaluation based on ID - [/import/evaluation/{id}/status](https://developer.timeedit.com/reference/setstatus.md): Set the evaluation status - [/import/feedback](https://developer.timeedit.com/reference/findfeedbacks.md): Find all feedback in evaluation - [/import/feedback](https://developer.timeedit.com/reference/savefeedback.md): Save feedback - [/import/participant](https://developer.timeedit.com/reference/participate.md): Start or resume participation in an evaluation - [/import/person](https://developer.timeedit.com/reference/findpersons.md): Find persons - [/import/person](https://developer.timeedit.com/reference/saveperson.md): Save a person - [/import/person/me](https://developer.timeedit.com/reference/getloggedinperson.md): Get the logged in person - [/import/person/{id}](https://developer.timeedit.com/reference/deleteperson.md): Delete a person based on ID - [/import/person/{id}](https://developer.timeedit.com/reference/getperson.md): Get a person by ID - [/import/person/{id}/activate](https://developer.timeedit.com/reference/activateperson.md): Activate a person - [/portal/members](https://developer.timeedit.com/reference/findmembertasks.md): Find tasks for members - [/portal/reports/{year}](https://developer.timeedit.com/reference/findreports.md): Find reports - [/portal/students](https://developer.timeedit.com/reference/findstudenttasks.md): Find tasks for students - [/portal/students/mine](https://developer.timeedit.com/reference/findstudenttasks_1.md): Find tasks for students - [/canonical/v2/callback/{uid}](https://developer.timeedit.com/reference/callback-1.md) - [/canonical/v2/related/{uid}](https://developer.timeedit.com/reference/searchrelated_v3.md): Search for related objects - [/import/v2/assessment](https://developer.timeedit.com/reference/searchassessment_v2.md): Search for assessments - [/import/v2/assessment/{id}](https://developer.timeedit.com/reference/findassessment_v2.md): Find an assessment based on ID and year - [/import/v2/availability-preference](https://developer.timeedit.com/reference/searchavailabilitypreference_v2.md): Search for availability preferences - [/import/v2/calendar](https://developer.timeedit.com/reference/findcalendar_v2.md): Search for default calendar of entity in year - [/import/v2/change](https://developer.timeedit.com/reference/searchchanges_v2.md): Search for changes - [/import/v2/csv/raw](https://developer.timeedit.com/reference/uploadraw.md): Upload a CSV in raw text - [/import/v2/faculty](https://developer.timeedit.com/reference/searchfaculty_v2.md): Search for faculties - [/import/v2/faculty](https://developer.timeedit.com/reference/savefaculty_v2.md): Save a faculty - [/import/v2/faculty/{id}](https://developer.timeedit.com/reference/findfaculty_v2.md): Find a faculty based on ID and year - [/import/v2/field](https://developer.timeedit.com/reference/searchfield_v2.md): Search for custom field in a given custom type - [/import/v2/institution](https://developer.timeedit.com/reference/findinstitution_v2.md): Find the institution in a year - [/import/v2/method](https://developer.timeedit.com/reference/searchmethod_v2.md): Search for methods - [/import/v2/method/{id}](https://developer.timeedit.com/reference/findmethod_v2.md): Find a method based on ID and year - [/import/v2/module](https://developer.timeedit.com/reference/searchmodule_v2.md): Search for modules - [/import/v2/module](https://developer.timeedit.com/reference/savemodule_v2.md): Save a module - [/import/v2/module/{id}](https://developer.timeedit.com/reference/deletemodule_v2.md): Delete a module - [/import/v2/module/{id}](https://developer.timeedit.com/reference/findmodule_v2.md): Find a module based on ID and year - [/import/v2/module-group](https://developer.timeedit.com/reference/searchgroup_v2.md): Search for groups - [/import/v2/module-group](https://developer.timeedit.com/reference/savegroup_v2.md): Save a group - [/import/v2/module-group/{id}](https://developer.timeedit.com/reference/deletegroup_v2.md): Delete a group - [/import/v2/module-group/{id}](https://developer.timeedit.com/reference/findgroup_v2.md): Find a group based on ID and year - [/import/v2/organisation](https://developer.timeedit.com/reference/searchorganisation_v2.md): Search for organisations - [/import/v2/organisation](https://developer.timeedit.com/reference/saveorganisation_v2.md): Save an organisation - [/import/v2/organisation/{id}](https://developer.timeedit.com/reference/findorganisation_v2.md): Find an organisation based on ID and year - [/import/v2/person](https://developer.timeedit.com/reference/deleteperson_v2.md): Deactivate a person - [/import/v2/person](https://developer.timeedit.com/reference/searchperson_v2.md): Search for persons - [/import/v2/person](https://developer.timeedit.com/reference/saveperson_v2.md): Save a person - [/import/v2/person/list](https://developer.timeedit.com/reference/listperson_v2.md): List all persons - [/import/v2/person/{id}](https://developer.timeedit.com/reference/deletepersonbyid_v2.md): Deactivate a person by ID - [/import/v2/person/{id}](https://developer.timeedit.com/reference/findperson_v2.md): Find a person based on ID - [/import/v2/qualification](https://developer.timeedit.com/reference/searchqualification_v2.md): Search for qualifications - [/import/v2/qualification](https://developer.timeedit.com/reference/savequalification_v2.md): Save a qualification - [/import/v2/qualification/{id}](https://developer.timeedit.com/reference/findqualification_v2.md): Find a qualification based on ID and year - [/import/v2/reference](https://developer.timeedit.com/reference/searchreference_v2.md): Search for references of a certain type - [/import/v2/reference](https://developer.timeedit.com/reference/savereference_v2.md): Save a reference - [/import/v2/reference-type](https://developer.timeedit.com/reference/searchreferencetypes_v2.md): Search for reference types - [/import/v2/route](https://developer.timeedit.com/reference/searchroute_v2.md): Search for routes - [/import/v2/route/{id}](https://developer.timeedit.com/reference/findroute_v2.md): Find a route based on ID - [/import/v2/specification](https://developer.timeedit.com/reference/searchspecification_v2.md): Search for specifications - [/import/v2/specification](https://developer.timeedit.com/reference/savespecification_v2.md): Save a specification - [/import/v2/specification/{id}](https://developer.timeedit.com/reference/findspecification_v2.md): Find a specification based on ID - [/import/v2/status](https://developer.timeedit.com/reference/searchstatuses_v2.md): Search for statuses - [/import/v2/study](https://developer.timeedit.com/reference/searchstudy_v2.md): Search for studies - [/import/v2/study](https://developer.timeedit.com/reference/savestudy_v2.md): Save a study - [/import/v2/study/{id}](https://developer.timeedit.com/reference/deletestudy_v2.md): Delete a study - [/import/v2/study/{id}](https://developer.timeedit.com/reference/findstudy_v2.md): Find a study based on ID and year - [/import/v2/team](https://developer.timeedit.com/reference/searchteam_v2.md): Search for teams - [/import/v2/team](https://developer.timeedit.com/reference/saveteam.md): Save a team - [/import/v2/team/{id}](https://developer.timeedit.com/reference/deleteteam.md): Delete a team - [/import/v2/team/{id}](https://developer.timeedit.com/reference/findteam.md): Find a team based on ID - [/canonical/v2/tasks](https://developer.timeedit.com/reference/searchtasks_v2.md): Search for tasks (experimental) - [/import/v2/version](https://developer.timeedit.com/reference/searchversions_v2.md): Retrieve the latest published versions. - [/import/v2/version](https://developer.timeedit.com/reference/publishversion_v2.md): Experimental: Publish entity and create new version - [/import/v2/version/{number}](https://developer.timeedit.com/reference/findversion_v2.md): Retrieve the details of a version. - [/canonical/v2/worklogs](https://developer.timeedit.com/reference/searchworklogs_v2.md): Search for worklogs (experimental) - [Save object](https://developer.timeedit.com/reference/broker_saveobject.md): Save an object of the specified type - [Search objects](https://developer.timeedit.com/reference/broker_searchobjects.md): Search for objects based on criteria - [Find object](https://developer.timeedit.com/reference/broker_findobject.md): Retrieve a specific object by its unique identifier and year - [Remove object](https://developer.timeedit.com/reference/broker_removeobject.md): Remove an object by its unique identifier and year - [Remove objects in bulk](https://developer.timeedit.com/reference/broker_removeallobjects.md): Remove objects in bulk based on criteria ## Changelog - [2026-06-30 New endpoint and parameter for objects](https://developer.timeedit.com/changelog/2026-06-30-new-endpoint-and-parameter-for-objects.md) - [2026-03-20 New endpoints for objects](https://developer.timeedit.com/changelog/2026-03-20-new-endpoints-for-objects.md) - [2026-02-12 New parameters added](https://developer.timeedit.com/changelog/2026-02-12-new-parameters-added.md) - [2026-01-15 New endpoints with External ID support](https://developer.timeedit.com/changelog/2026-01-15-new-endpoints-with-external-id-support.md) - [2025-11-01 External ID support added](https://developer.timeedit.com/changelog/2025-11-01-external-id-support-added.md)