v1

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

Listar Colegiaturas

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

get/memberships

Query parameters

program_idstring required

Parametro requerido para consultar las inscripciones de un programa

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

Ok

Example response

{
  "items": {
    "items": 112,
    "page": 1,
    "total_pages": 11
  },
  "data": [
    {
      "id": "mbs_520dd7ee-5039-48d6-b015-19a60629a115",
      "name": "Administración",
      "program_id": "prm_48ec2f25-74e1-406a-a42f-4636bcce7877",
      "workday": true,
      "periodicity": "monthly",
      "payment_plan": 10,
      "amount": 1000,
      "external_id": "123abc",
      "metadata": {
        "id_alumno": "123abc"
      }
    }
  ]
}