v1

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

Programas

Listar Programas

Ofrece la lista de todos los programas académicos disponibles en las escuelas y campus.

get/programs

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.

periodIDstring uuid required

ID del periodo que se desea trabajar.

Response

Listar Programas

programIDstring

namestring

external_idstring

campus_period_idstring

metadataobject

Campo arbitrario de datos de terceros

Example response

[
  {
    "programID": "prm_62d63d88-4d74-44f2-b017-b46b90d3347b",
    "name": "Administración",
    "external_id": "Campo arbitrario de datos de terceros",
    "campus_period_id": "62d63d88-4d74-44f2-b017-b46b90d3347b",
    "metadata": {
      "id_alumno": "123abc"
    }
  }
]