Brein API

Session

Get all sessions with filters

GET

/api/v1/session

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

Get all sessions with filters › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all sessions 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)

Create a new session

POST

/api/v1/session

Create a new session with the provided data

Create a new session › Request Body

groupIdsnumber[] · required
Group list of Ids
titlestring · required
Session title
mandatoryboolean · required
Session mandatory?

descriptionstring
Session description

Create a new session › Responses

Session created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

taskobject

POST /api/v1/session

curl --request POST \
  --url /api/v1/session \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupIds": [
    0
  ],
  "title": "title",
  "description": "description",
  "mandatory": true
}
'

shell

Show example in

Request Body Example

{
  "groupIds": [
    0
  ],
  "title": "title",
  "description": "description",
  "mandatory": true
}

json

Example Responses

No example

json

application/json

Get session by ID

GET

/api/v1/session/{id}

Retrieve a specific session by its ID

Get session by ID › path Parameters

idnumber · min: 1 · required
Id

Get session by ID › Responses

Session detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

taskobject

GET /api/v1/session/{id}

curl --request GET \
  --url /api/v1/session/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a session

PUT

/api/v1/session/{id}

Update an existing session by its ID

Update a session › path Parameters

idnumber · min: 1 · required
Id

Update a session › Request Body

sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

Update a session › Responses

Session updated

No data returned

PUT /api/v1/session/{id}

curl --request PUT \
  --url /api/v1/session/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionDuration": 15,
  "breakBetweenSessions": 15,
  "status": "DRAFT"
}
'

shell

Show example in

Request Body Example

{
  "sessionDuration": 15,
  "breakBetweenSessions": 15,
  "status": "DRAFT"
}

json

Example Responses

No example

plain

Delete a session

DELETE

/api/v1/session/{id}

Delete a session by its ID

Delete a session › path Parameters

idnumber · min: 1 · required
Id

Delete a session › Responses

Session deleted

No data returned

Delete pending session by task ID

POST

/api/v1/session/pending/{id}/delete

Delete a pending session by its task ID with a reason

Delete pending session by task ID › path Parameters

idnumber · min: 1 · required
Id

Delete pending session by task ID › Request Body

reasonstring
Reason

Delete pending session by task ID › Responses

Session deleted

No data returned

POST /api/v1/session/pending/{id}/delete

curl --request POST \
  --url /api/v1/session/pending/: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

Update session slots

PUT

/api/v1/session/{id}/slots

Update the time slots for a specific session

Update session slots › path Parameters

idnumber · min: 1 · required
Id

Update session slots › Request Body

sessionDurationnumber · required
Session duration in minutes
breakBetweenSessionsnumber · required
Break between sessions in minutes
daysstring[] · required
Days with start and end time
Example: [{"startTime":"2025-04-26T21:00:04.989Z","endTime":"2025-04-28T23:50:04.989Z"}]

Update session slots › Responses

Session updated

No data returned

PUT /api/v1/session/{id}/slots

curl --request PUT \
  --url /api/v1/session/:id/slots \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionDuration": 0,
  "breakBetweenSessions": 0,
  "days": [
    "string"
  ]
}
'

shell

Show example in

Request Body Example

{
  "sessionDuration": 0,
  "breakBetweenSessions": 0,
  "days": [
    "string"
  ]
}

json

Example Responses

No example

plain

Publish a session

PUT

/api/v1/session/{id}/publish

Publish a session, making it available to users

Publish a session › path Parameters

idnumber · min: 1 · required
Id

Publish a session › Request Body

daysobject[] · required
Session days

Publish a session › Responses

Session published

No data returned

PUT /api/v1/session/{id}/publish

curl --request PUT \
  --url /api/v1/session/:id/publish \
  --header 'Content-Type: application/json' \
  --data '
{
  "days": [
    {
      "id": 0,
      "eventType": "ON_SITE",
      "meetingLink": "meetingLink",
      "location": "location"
    }
  ]
}
'

shell

Show example in

Request Body Example

{
  "days": [
    {
      "id": 0,
      "eventType": "ON_SITE",
      "meetingLink": "meetingLink",
      "location": "location"
    }
  ]
}

json

Example Responses

No example

plain

Pending (Task)Pending Reminder

Brein API

Session

Get all sessions with filters

GET

/api/v1/session

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

Get all sessions with filters › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all sessions 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)

Create a new session

POST

/api/v1/session

Create a new session with the provided data

Create a new session › Request Body

groupIdsnumber[] · required
Group list of Ids
titlestring · required
Session title
mandatoryboolean · required
Session mandatory?

descriptionstring
Session description

Create a new session › Responses

Session created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

taskobject

POST /api/v1/session

curl --request POST \
  --url /api/v1/session \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupIds": [
    0
  ],
  "title": "title",
  "description": "description",
  "mandatory": true
}
'

shell

Show example in

Request Body Example

{
  "groupIds": [
    0
  ],
  "title": "title",
  "description": "description",
  "mandatory": true
}

json

Example Responses

No example

json

application/json

Get session by ID

GET

/api/v1/session/{id}

Retrieve a specific session by its ID

Get session by ID › path Parameters

idnumber · min: 1 · required
Id

Get session by ID › Responses

Session detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

taskobject

GET /api/v1/session/{id}

curl --request GET \
  --url /api/v1/session/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a session

PUT

/api/v1/session/{id}

Update an existing session by its ID

Update a session › path Parameters

idnumber · min: 1 · required
Id

Update a session › Request Body

sessionDurationnumber · required
Session duration
Example: 15
breakBetweenSessionsnumber · required
Break between sessions
Example: 15
statusstring · enum · required
Status of session
Enum values:
DRAFT
PUBLISHED

Update a session › Responses

Session updated

No data returned

PUT /api/v1/session/{id}

curl --request PUT \
  --url /api/v1/session/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionDuration": 15,
  "breakBetweenSessions": 15,
  "status": "DRAFT"
}
'

shell

Show example in

Request Body Example

{
  "sessionDuration": 15,
  "breakBetweenSessions": 15,
  "status": "DRAFT"
}

json

Example Responses

No example

plain

Delete a session

DELETE

/api/v1/session/{id}

Delete a session by its ID

Delete a session › path Parameters

idnumber · min: 1 · required
Id

Delete a session › Responses

Session deleted

No data returned

Delete pending session by task ID

POST

/api/v1/session/pending/{id}/delete

Delete a pending session by its task ID with a reason

Delete pending session by task ID › path Parameters

idnumber · min: 1 · required
Id

Delete pending session by task ID › Request Body

reasonstring
Reason

Delete pending session by task ID › Responses

Session deleted

No data returned

POST /api/v1/session/pending/{id}/delete

curl --request POST \
  --url /api/v1/session/pending/: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

Update session slots

PUT

/api/v1/session/{id}/slots

Update the time slots for a specific session

Update session slots › path Parameters

idnumber · min: 1 · required
Id

Update session slots › Request Body

sessionDurationnumber · required
Session duration in minutes
breakBetweenSessionsnumber · required
Break between sessions in minutes
daysstring[] · required
Days with start and end time
Example: [{"startTime":"2025-04-26T21:00:04.989Z","endTime":"2025-04-28T23:50:04.989Z"}]

Update session slots › Responses

Session updated

No data returned

PUT /api/v1/session/{id}/slots

curl --request PUT \
  --url /api/v1/session/:id/slots \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionDuration": 0,
  "breakBetweenSessions": 0,
  "days": [
    "string"
  ]
}
'

shell

Show example in

Request Body Example

{
  "sessionDuration": 0,
  "breakBetweenSessions": 0,
  "days": [
    "string"
  ]
}

json

Example Responses

No example

plain

Publish a session

PUT

/api/v1/session/{id}/publish

Publish a session, making it available to users

Publish a session › path Parameters

idnumber · min: 1 · required
Id

Publish a session › Request Body

daysobject[] · required
Session days

Publish a session › Responses

Session published

No data returned

PUT /api/v1/session/{id}/publish

curl --request PUT \
  --url /api/v1/session/:id/publish \
  --header 'Content-Type: application/json' \
  --data '
{
  "days": [
    {
      "id": 0,
      "eventType": "ON_SITE",
      "meetingLink": "meetingLink",
      "location": "location"
    }
  ]
}
'

shell

Show example in

Request Body Example

{
  "days": [
    {
      "id": 0,
      "eventType": "ON_SITE",
      "meetingLink": "meetingLink",
      "location": "location"
    }
  ]
}

json

Example Responses

No example

plain

Pending (Task)Pending Reminder