Brein API

Pending (Task)

Get all tasks with filters

GET

/api/v1/pending

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

Get all tasks with filters › query Parameters

groupIdsnumber[] · required
Group list of Ids
mandatoryboolean · required
Task mandatory?
expiredboolean · required
Task expired?
archivedboolean · required
Task archived?
completedboolean · required
Task completed?
pagenumber
Current page
pageSizenumber
Page size
keystring
Search by task title or description

Get all tasks 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/pending

curl --request GET \
  --url '/api/v1/pending?groupIds=%3Cvalue%3E&mandatory=%3Cbool%3E&expired=%3Cbool%3E&archived=%3Cbool%3E&completed=%3Cbool%3E'

shell

Show example in

Example Responses

No example

json

application/json

Create a new task

POST

/api/v1/pending

Create a new task with the provided data

Create a new task › Request Body

titlestring · required
Title task
dueDatestring · date-time · required
Expiration date
mandatoryboolean · required
Task mandatory?
descriptionstring · required
Description task
documentSlugsstring[] · required
Document slugs
groupIdsnumber[] · required
Group list of Ids

sessionobject
reasonstring
Reason for deletion

Create a new task › Responses

Task created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
titlestring · required
Title task
dueDatestring · date-time · required
Expiration date
mandatoryboolean · required
Task mandatory?
descriptionstring · required
Description task
documentSlugsstring[] · required
Document slugs

sessionobject
reasonstring
Reason for deletion

POST /api/v1/pending

curl --request POST \
  --url /api/v1/pending \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "title",
  "dueDate": "2024-08-25T15:00:00Z",
  "mandatory": true,
  "description": "description",
  "documentSlugs": [
    "string"
  ],
  "session": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "sessionDuration": 15,
    "breakBetweenSessions": 15,
    "task": {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "title": "title",
      "dueDate": "2024-08-25T15:00:00Z",
      "mandatory": true,
      "description": "description",
      "documentSlugs": [
        "string"
      ],
      "reason": "reason"
    },
    "status": "DRAFT"
  },
  "reason": "reason",
  "groupIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "title": "title",
  "dueDate": "2024-08-25T15:00:00Z",
  "mandatory": true,
  "description": "description",
  "documentSlugs": [
    "string"
  ],
  "session": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "sessionDuration": 15,
    "breakBetweenSessions": 15,
    "task": {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "title": "title",
      "dueDate": "2024-08-25T15:00:00Z",
      "mandatory": true,
      "description": "description",
      "documentSlugs": [
        "string"
      ],
      "reason": "reason"
    },
    "status": "DRAFT"
  },
  "reason": "reason",
  "groupIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Get public task by slug

GET

/api/v1/pending/share/{taskSlug}

Retrieve a public task by its slug for sharing purposes

Get public task by slug › path Parameters

taskSlugstring · required

Get public task by slug › Responses

No data returned

GET /api/v1/pending/share/{taskSlug}

curl --request GET \
  --url /api/v1/pending/share/:taskSlug

shell

Show example in

Example Responses

No example

plain

Get pending tasks for current user

GET

/api/v1/pending/pending-tasks

Retrieve all pending tasks for the currently authenticated user

Get pending tasks for current user › Responses

List of pending tasks for the user

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
titlestring · required
Title task
dueDatestring · date-time · required
Expiration date
mandatoryboolean · required
Task mandatory?
descriptionstring · required
Description task
documentSlugsstring[] · required
Document slugs

sessionobject
reasonstring
Reason for deletion

GET /api/v1/pending/pending-tasks

curl --request GET \
  --url /api/v1/pending/pending-tasks

shell

Show example in

Example Responses

No example

json

application/json

Get task by ID

GET

/api/v1/pending/{id}

Retrieve a specific task by its ID with all relations

Get task by ID › path Parameters

idnumber · min: 1 · required
Id

Get task by ID › Responses

Task detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
titlestring · required
Title task
dueDatestring · date-time · required
Expiration date
mandatoryboolean · required
Task mandatory?
descriptionstring · required
Description task
documentSlugsstring[] · required
Document slugs

sessionobject
reasonstring
Reason for deletion

GET /api/v1/pending/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a task

PUT

/api/v1/pending/{id}

Update an existing task by its ID

Update a task › path Parameters

idnumber · min: 1 · required
Id

Update a task › Request Body

titlestring
Title task
dueDatestring · date-time
Expiration date
mandatoryboolean
Task mandatory?
descriptionstring
Description task
documentSlugsstring[]
Document slugs
sessionobject
reasonstring
Reason for deletion
groupIdsnumber[]
Group list of Ids

Update a task › Responses

Task updated

No data returned

PUT /api/v1/pending/{id}

curl --request PUT \
  --url /api/v1/pending/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "title",
  "dueDate": "2024-08-25T15:00:00Z",
  "mandatory": true,
  "description": "description",
  "documentSlugs": [
    "string"
  ],
  "session": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "sessionDuration": 15,
    "breakBetweenSessions": 15,
    "task": {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "title": "title",
      "dueDate": "2024-08-25T15:00:00Z",
      "mandatory": true,
      "description": "description",
      "documentSlugs": [
        "string"
      ],
      "reason": "reason"
    },
    "status": "DRAFT"
  },
  "reason": "reason",
  "groupIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "title": "title",
  "dueDate": "2024-08-25T15:00:00Z",
  "mandatory": true,
  "description": "description",
  "documentSlugs": [
    "string"
  ],
  "session": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "sessionDuration": 15,
    "breakBetweenSessions": 15,
    "task": {
      "id": 0,
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z",
      "title": "title",
      "dueDate": "2024-08-25T15:00:00Z",
      "mandatory": true,
      "description": "description",
      "documentSlugs": [
        "string"
      ],
      "reason": "reason"
    },
    "status": "DRAFT"
  },
  "reason": "reason",
  "groupIds": [
    0
  ]
}

json

Example Responses

No example

plain

Get task detail by ID

GET

/api/v1/pending/{id}/detail

Retrieve detailed information about a specific task by its ID

Get task detail by ID › path Parameters

idnumber · min: 1 · required
Id

Get task detail by ID › Responses

Task detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
titlestring · required
Title task
dueDatestring · date-time · required
Expiration date
mandatoryboolean · required
Task mandatory?
descriptionstring · required
Description task
documentSlugsstring[] · required
Document slugs

sessionobject
reasonstring
Reason for deletion

GET /api/v1/pending/{id}/detail

curl --request GET \
  --url /api/v1/pending/:id/detail

shell

Show example in

Example Responses

No example

json

application/json

Delete a task with reason

POST

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

Delete a task by its ID with a provided reason

Delete a task with reason › path Parameters

idnumber · min: 1 · required
Id

Delete a task with reason › Request Body

reasonstring
Reason

Delete a task with reason › Responses

Task deleted

No data returned

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

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

Send reminder for a task

POST

/api/v1/pending/{id}/reminder

Send a reminder notification for a specific task

Send reminder for a task › path Parameters

idnumber · min: 1 · required
Id

Send reminder for a task › Responses

No data returned

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

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

shell

Show example in

Example Responses

No example

plain

Mark task as viewed

PATCH

/api/v1/pending/{id}/view

Mark a task as viewed by the current user

Mark task as viewed › path Parameters

idnumber · min: 1 · required
Id

Mark task as viewed › Responses

Task mark as viewed

No data returned

PATCH /api/v1/pending/{id}/view

curl --request PATCH \
  --url /api/v1/pending/:id/view

shell

Show example in

Example Responses

No example

plain

Mark task as completed

PATCH

/api/v1/pending/{id}/complete

Mark a task as completed by the current user

Mark task as completed › path Parameters

idnumber · min: 1 · required
Id

Mark task as completed › Responses

Task mark as completed

No data returned

PATCH /api/v1/pending/{id}/complete

curl --request PATCH \
  --url /api/v1/pending/:id/complete

shell

Show example in

Example Responses

No example

plain

Revert task completion

PATCH

/api/v1/pending/{id}/complete/revert

Revert a completed task back to not completed status

Revert task completion › path Parameters

idnumber · min: 1 · required
Id

Revert task completion › Responses

Task mark as not completed

No data returned

PATCH /api/v1/pending/{id}/complete/revert

curl --request PATCH \
  --url /api/v1/pending/:id/complete/revert

shell

Show example in

Example Responses

No example

plain

Archive a task

PATCH

/api/v1/pending/{id}/archive

Archive a task by the current user

Archive a task › path Parameters

idnumber · min: 1 · required
Id

Archive a task › Responses

Task mark as archived

No data returned

PATCH /api/v1/pending/{id}/archive

curl --request PATCH \
  --url /api/v1/pending/:id/archive

shell

Show example in

Example Responses

No example

plain

Unarchive a task

PATCH

/api/v1/pending/{id}/unarchive

Unarchive a previously archived task by the current user

Unarchive a task › path Parameters

idnumber · min: 1 · required
Id

Unarchive a task › Responses

Task mark as unarchived

No data returned

PATCH /api/v1/pending/{id}/unarchive

curl --request PATCH \
  --url /api/v1/pending/:id/unarchive

shell

Show example in

Example Responses

No example

plain

Generate signed URL for task

POST

/api/v1/pending/signed-url

Generate a signed URL for accessing task resources

Generate signed URL for task › Request Body

methodstring · required
Method of request (GET | PUT)
Example: GET
contentTypestring · required
Content type of de document
Example: image/webp
slugstring · required
Document slug
Example: 1-school

Generate signed URL for task › Responses

No data returned

POST /api/v1/pending/signed-url

curl --request POST \
  --url /api/v1/pending/signed-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "GET",
  "contentType": "image/webp",
  "slug": "1-school"
}
'

shell

Show example in

Request Body Example

{
  "method": "GET",
  "contentType": "image/webp",
  "slug": "1-school"
}

json

Example Responses

No example

plain

Auth Session