v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-07-116470172.6 KB

Periodos

Obtener Periodos

Obtener una lista de periodos escolares

get/periods

Query parameters

qstring

Parámetro para realizar búsquedas basadas en key y value de los datos o dentro del metadata usando metadata.key=value. Los criterios de búsqueda disponibles son:

name
date_from
date_to
page
status
external_id
metadata Puedes proporcionar múltiples criterios separados por espacio. Ejemplo: external_id=123456 metadata.student_curp=12345

Headers

campusIDstring uuid required

ID del Campus que se desea trabajar.

Response

namestring

start_date"string

end_datestring

status'active' | 'inactive' | 'deleted'

is_defaultboolean

parent_idstring

campus_idstring

Example response

{
  "name": "K12 Academic Year 2024-2025",
  "start_date\"": "2024-12-09",
  "end_date": "2024-12-09",
  "status": "active",
  "is_default": true,
  "parent_id": "uuid",
  "campus_id": "uuid"
}