v1

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

Inscripciones

Listar Inscripciones

Ofrece la lista de todos las Inscripciones disponibles en las escuelas y campus.

get/inscriptions

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

program_idstring required

Parametro requerido para consultar las inscripciones de un programa

Headers

campusIDstring uuid required

ID del Campus que se desea trabajar.

periodIDstring uuid required

ID del periodo que se desea trabajar.

Response

idstring

namestring

program_idstring

amountinteger

pay_datestring date

external_idstring

metadataobject

Campo arbitrario de datos de terceros

Example response

[
  {
    "id": "prm_62d63d88-4d74-44f2-b017-b46b90d3347b",
    "name": "Administración",
    "program_id": "prm_62d63d88-4d74-44f2-b017-b46b90d3347b",
    "amount": 1000,
    "pay_date": "2023-11-10",
    "external_id": "2a09691a-a473-46de-b0a7-45269007c59c",
    "metadata": {
      "id_alumno": "123abc"
    }
  }
]