Brein API

Documents

Get all documents with pagination

GET

/api/v1/documents

Retrieve a paginated list of documents based on query parameters

Get all documents with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all documents with pagination › 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 document

POST

/api/v1/documents

Create a new document for the current school

Create a new document › Request Body

namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

Create a new document › Responses

Documents created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

POST /api/v1/documents

curl --request POST \
  --url /api/v1/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}
'

shell

Show example in

Request Body Example

{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}

json

Example Responses

No example

json

application/json

Get documents for current school

GET

/api/v1/documents/school

Retrieve all documents for the current school

Get documents for current school › 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/documents/school

curl --request GET \
  --url /api/v1/documents/school

shell

Show example in

Example Responses

No example

json

application/json

Get document by ID

GET

/api/v1/documents/{id}

Retrieve a specific document by its ID

Get document by ID › path Parameters

idnumber · min: 1 · required
Id

Get document by ID › Responses

Documents detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

GET /api/v1/documents/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a document

PUT

/api/v1/documents/{id}

Update an existing document by its ID

Update a document › path Parameters

idnumber · min: 1 · required
Id

Update a document › Request Body

namestring
Document name
Example: Terms and conditions
slugstring
Document slug
Example: /{tenant-id}/documents/{name}

Update a document › Responses

Documents updated

No data returned

PUT /api/v1/documents/{id}

curl --request PUT \
  --url /api/v1/documents/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}
'

shell

Show example in

Request Body Example

{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}

json

Example Responses

No example

plain

Delete a document

DELETE

/api/v1/documents/{id}

Delete a document by its ID

Delete a document › path Parameters

idnumber · min: 1 · required
Id

Delete a document › Responses

Documents deleted

No data returned

Generate signed URL for document upload

POST

/api/v1/documents/{entity}/signed-url

Generate a signed URL for uploading a document to S3

Generate signed URL for document upload › path Parameters

entitystring · required

Generate signed URL for document upload › Request Body

contentTypestring · required
Content type of the document
Example: application/pdf
slugstring · required
Document slug
Example: tenant-id/doc/file.pdf
namestring · required
Document name
Example: file.pdf

methodstring
Method ( GET | PUT )
Example: PUT

Generate signed URL for document upload › Responses

URL Generated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

POST /api/v1/documents/{entity}/signed-url

curl --request POST \
  --url /api/v1/documents/:entity/signed-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "PUT",
  "contentType": "application/pdf",
  "slug": "tenant-id/doc/file.pdf",
  "name": "file.pdf"
}
'

shell

Show example in

Request Body Example

{
  "method": "PUT",
  "contentType": "application/pdf",
  "slug": "tenant-id/doc/file.pdf",
  "name": "file.pdf"
}

json

Example Responses

No example

json

application/json

Export parents to Excel

GET

/api/v1/documents/export/parents

Export all parents data to Excel file for contractual backup

Export parents to Excel › Responses

Signed URL for Excel file with parents data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/parents

curl --request GET \
  --url /api/v1/documents/export/parents

shell

Show example in

Example Responses

No example

json

application/json

Export students to Excel

GET

/api/v1/documents/export/students

Export all students data to Excel file for contractual backup

Export students to Excel › Responses

Signed URL for Excel file with students data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/students

curl --request GET \
  --url /api/v1/documents/export/students

shell

Show example in

Example Responses

No example

json

application/json

Export teachers to Excel

GET

/api/v1/documents/export/teachers

Export all teachers data to Excel file for contractual backup

Export teachers to Excel › Responses

Signed URL for Excel file with teachers data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/teachers

curl --request GET \
  --url /api/v1/documents/export/teachers

shell

Show example in

Example Responses

No example

json

application/json

Export administrative staff to Excel

GET

/api/v1/documents/export/administrative

Export all administrative and school administrator data to Excel file for contractual backup

Export administrative staff to Excel › Responses

Signed URL for Excel file with administrative data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/administrative

curl --request GET \
  --url /api/v1/documents/export/administrative

shell

Show example in

Example Responses

No example

json

application/json

Export all roles to Excel

GET

/api/v1/documents/export/all

Export all data (parents, students, teachers, and administrative) to a single Excel file with multiple sheets for contractual backup

Export all roles to Excel › Responses

Signed URL for Excel file with all roles data in separate sheets

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/all

curl --request GET \
  --url /api/v1/documents/export/all

shell

Show example in

Example Responses

No example

json

application/json

Permission Reset Data

Brein API

Documents

Get all documents with pagination

GET

/api/v1/documents

Retrieve a paginated list of documents based on query parameters

Get all documents with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all documents with pagination › 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 document

POST

/api/v1/documents

Create a new document for the current school

Create a new document › Request Body

namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

Create a new document › Responses

Documents created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

POST /api/v1/documents

curl --request POST \
  --url /api/v1/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}
'

shell

Show example in

Request Body Example

{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}

json

Example Responses

No example

json

application/json

Get documents for current school

GET

/api/v1/documents/school

Retrieve all documents for the current school

Get documents for current school › 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/documents/school

curl --request GET \
  --url /api/v1/documents/school

shell

Show example in

Example Responses

No example

json

application/json

Get document by ID

GET

/api/v1/documents/{id}

Retrieve a specific document by its ID

Get document by ID › path Parameters

idnumber · min: 1 · required
Id

Get document by ID › Responses

Documents detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

GET /api/v1/documents/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a document

PUT

/api/v1/documents/{id}

Update an existing document by its ID

Update a document › path Parameters

idnumber · min: 1 · required
Id

Update a document › Request Body

namestring
Document name
Example: Terms and conditions
slugstring
Document slug
Example: /{tenant-id}/documents/{name}

Update a document › Responses

Documents updated

No data returned

PUT /api/v1/documents/{id}

curl --request PUT \
  --url /api/v1/documents/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}
'

shell

Show example in

Request Body Example

{
  "name": "Terms and conditions",
  "slug": "/{tenant-id}/documents/{name}"
}

json

Example Responses

No example

plain

Delete a document

DELETE

/api/v1/documents/{id}

Delete a document by its ID

Delete a document › path Parameters

idnumber · min: 1 · required
Id

Delete a document › Responses

Documents deleted

No data returned

Generate signed URL for document upload

POST

/api/v1/documents/{entity}/signed-url

Generate a signed URL for uploading a document to S3

Generate signed URL for document upload › path Parameters

entitystring · required

Generate signed URL for document upload › Request Body

contentTypestring · required
Content type of the document
Example: application/pdf
slugstring · required
Document slug
Example: tenant-id/doc/file.pdf
namestring · required
Document name
Example: file.pdf

methodstring
Method ( GET | PUT )
Example: PUT

Generate signed URL for document upload › Responses

URL Generated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Document name
Example: Terms and conditions
slugstring · required
Document slug
Example: /{tenant-id}/documents/{name}

POST /api/v1/documents/{entity}/signed-url

curl --request POST \
  --url /api/v1/documents/:entity/signed-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "PUT",
  "contentType": "application/pdf",
  "slug": "tenant-id/doc/file.pdf",
  "name": "file.pdf"
}
'

shell

Show example in

Request Body Example

{
  "method": "PUT",
  "contentType": "application/pdf",
  "slug": "tenant-id/doc/file.pdf",
  "name": "file.pdf"
}

json

Example Responses

No example

json

application/json

Export parents to Excel

GET

/api/v1/documents/export/parents

Export all parents data to Excel file for contractual backup

Export parents to Excel › Responses

Signed URL for Excel file with parents data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/parents

curl --request GET \
  --url /api/v1/documents/export/parents

shell

Show example in

Example Responses

No example

json

application/json

Export students to Excel

GET

/api/v1/documents/export/students

Export all students data to Excel file for contractual backup

Export students to Excel › Responses

Signed URL for Excel file with students data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/students

curl --request GET \
  --url /api/v1/documents/export/students

shell

Show example in

Example Responses

No example

json

application/json

Export teachers to Excel

GET

/api/v1/documents/export/teachers

Export all teachers data to Excel file for contractual backup

Export teachers to Excel › Responses

Signed URL for Excel file with teachers data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/teachers

curl --request GET \
  --url /api/v1/documents/export/teachers

shell

Show example in

Example Responses

No example

json

application/json

Export administrative staff to Excel

GET

/api/v1/documents/export/administrative

Export all administrative and school administrator data to Excel file for contractual backup

Export administrative staff to Excel › Responses

Signed URL for Excel file with administrative data

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/administrative

curl --request GET \
  --url /api/v1/documents/export/administrative

shell

Show example in

Example Responses

No example

json

application/json

Export all roles to Excel

GET

/api/v1/documents/export/all

Export all data (parents, students, teachers, and administrative) to a single Excel file with multiple sheets for contractual backup

Export all roles to Excel › Responses

Signed URL for Excel file with all roles data in separate sheets

urlstring · required
Signed URL for the exported report
Example: https://example.com/report.pdf

GET /api/v1/documents/export/all

curl --request GET \
  --url /api/v1/documents/export/all

shell

Show example in

Example Responses

No example

json

application/json

Permission Reset Data