Brein API

Event

Get all events with filters

GET

/api/v1/event

Retrieve a paginated list of events based on query parameters and user role

Get all events with filters › query Parameters

datestring · required
Date to filter events (format YYYY-MM-DD)
globalboolean · required
Filter global
myGroupsboolean · required
Filter by groups
sessionsboolean · required
Filter by sessions
pagenumber
Current page
pageSizenumber
Page size
groupIdsnumber[]
Group list of Ids

Get all events with filters › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/event

curl --request GET \
  --url '/api/v1/event?date=2025-01-27&global=%3Cbool%3E&myGroups=%3Cbool%3E&sessions=%3Cbool%3E'

shell

Show example in

Example Responses

No example

json

application/json

Create a new event

POST

/api/v1/event

Create a new event with the provided data

Create a new event › Request Body

descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs
groupIdsnumber[] · required
Group list of Ids

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

Create a new event › Responses

Event created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum · required
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

POST /api/v1/event

curl --request POST \
  --url /api/v1/event \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Get public event by slug

GET

/api/v1/event/share/{eventSlug}

Retrieve a public event by its slug for sharing purposes

Get public event by slug › path Parameters

eventSlugstring · required

Get public event by slug › Responses

No data returned

GET /api/v1/event/share/{eventSlug}

curl --request GET \
  --url /api/v1/event/share/:eventSlug

shell

Show example in

Example Responses

No example

plain

Get event by ID

GET

/api/v1/event/{id}

Retrieve a specific event by its ID with all relations

Get event by ID › path Parameters

idnumber · min: 1 · required
Id

Get event by ID › Responses

Event detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum · required
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

Update an event

PUT

/api/v1/event/{id}

Update an existing event by its ID

Update an event › path Parameters

idnumber · min: 1 · required
Id

Update an event › Request Body

groupIdsnumber[] · required
Group list of Ids

descriptionstring
Description event
eventTypestring · enum
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean
Event mandatory?
startTimestring · date-time
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
studentsobject[]
Students associated with this event
levelsstring[]
School levels
Example: Primary
documentSlugsstring[]
Document slugs
reasonstring
Reason for deletion

Update an event › Responses

Event updated

No data returned

PUT /api/v1/event/{id}

curl --request PUT \
  --url /api/v1/event/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "creatorType": "TEACHER",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "creatorType": "TEACHER",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}

json

Example Responses

No example

plain

Delete an event

DELETE

/api/v1/event/{id}

Delete an event by its ID

Delete an event › path Parameters

idnumber · min: 1 · required
Id

Delete an event › Responses

Event deleted

No data returned

Send reminder for an event

POST

/api/v1/event/{id}/reminder

Send a reminder notification for a specific event

Send reminder for an event › path Parameters

idnumber · min: 1 · required
Id

Send reminder for an event › Responses

No data returned

POST /api/v1/event/{id}/reminder

curl --request POST \
  --url /api/v1/event/:id/reminder

shell

Show example in

Example Responses

No example

plain

Delete an event with reason

POST

/api/v1/event/{id}/delete

Delete an event by its ID with a provided reason

Delete an event with reason › path Parameters

idnumber · min: 1 · required
Id

Delete an event with reason › Request Body

reasonstring · required
Reason

Delete an event with reason › Responses

Event deleted

No data returned

POST /api/v1/event/{id}/delete

curl --request POST \
  --url /api/v1/event/:id/delete \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "reason"
}
'

shell

Show example in

Request Body Example

{
  "reason": "reason"
}

json

Example Responses

No example

plain

Time Slot Exit Permission

Brein API

Event

Get all events with filters

GET

/api/v1/event

Retrieve a paginated list of events based on query parameters and user role

Get all events with filters › query Parameters

datestring · required
Date to filter events (format YYYY-MM-DD)
globalboolean · required
Filter global
myGroupsboolean · required
Filter by groups
sessionsboolean · required
Filter by sessions
pagenumber
Current page
pageSizenumber
Page size
groupIdsnumber[]
Group list of Ids

Get all events with filters › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/event

curl --request GET \
  --url '/api/v1/event?date=2025-01-27&global=%3Cbool%3E&myGroups=%3Cbool%3E&sessions=%3Cbool%3E'

shell

Show example in

Example Responses

No example

json

application/json

Create a new event

POST

/api/v1/event

Create a new event with the provided data

Create a new event › Request Body

descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs
groupIdsnumber[] · required
Group list of Ids

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

Create a new event › Responses

Event created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum · required
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

POST /api/v1/event

curl --request POST \
  --url /api/v1/event \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Get public event by slug

GET

/api/v1/event/share/{eventSlug}

Retrieve a public event by its slug for sharing purposes

Get public event by slug › path Parameters

eventSlugstring · required

Get public event by slug › Responses

No data returned

GET /api/v1/event/share/{eventSlug}

curl --request GET \
  --url /api/v1/event/share/:eventSlug

shell

Show example in

Example Responses

No example

plain

Get event by ID

GET

/api/v1/event/{id}

Retrieve a specific event by its ID with all relations

Get event by ID › path Parameters

idnumber · min: 1 · required
Id

Get event by ID › Responses

Event detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum · required
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

Update an event

PUT

/api/v1/event/{id}

Update an existing event by its ID

Update an event › path Parameters

idnumber · min: 1 · required
Id

Update an event › Request Body

groupIdsnumber[] · required
Group list of Ids

descriptionstring
Description event
eventTypestring · enum
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean
Event mandatory?
startTimestring · date-time
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
studentsobject[]
Students associated with this event
levelsstring[]
School levels
Example: Primary
documentSlugsstring[]
Document slugs
reasonstring
Reason for deletion

Update an event › Responses

Event updated

No data returned

PUT /api/v1/event/{id}

curl --request PUT \
  --url /api/v1/event/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "creatorType": "TEACHER",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "description": "description",
  "eventType": "ON_SITE",
  "mandatory": true,
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "timezone": "America/Mexico_City",
  "frequencyType": "NO_REPEAT",
  "creatorType": "TEACHER",
  "students": [
    {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ],
  "levels": [
    "string"
  ],
  "documentSlugs": [
    "string"
  ],
  "reason": "reason",
  "groupIds": [
    0
  ]
}

json

Example Responses

No example

plain

Delete an event

DELETE

/api/v1/event/{id}

Delete an event by its ID

Delete an event › path Parameters

idnumber · min: 1 · required
Id

Delete an event › Responses

Event deleted

No data returned

Send reminder for an event

POST

/api/v1/event/{id}/reminder

Send a reminder notification for a specific event

Send reminder for an event › path Parameters

idnumber · min: 1 · required
Id

Send reminder for an event › Responses

No data returned

POST /api/v1/event/{id}/reminder

curl --request POST \
  --url /api/v1/event/:id/reminder

shell

Show example in

Example Responses

No example

plain

Delete an event with reason

POST

/api/v1/event/{id}/delete

Delete an event by its ID with a provided reason

Delete an event with reason › path Parameters

idnumber · min: 1 · required
Id

Delete an event with reason › Request Body

reasonstring · required
Reason

Delete an event with reason › Responses

Event deleted

No data returned

POST /api/v1/event/{id}/delete

curl --request POST \
  --url /api/v1/event/:id/delete \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "reason"
}
'

shell

Show example in

Request Body Example

{
  "reason": "reason"
}

json

Example Responses

No example

plain

Time Slot Exit Permission