Brein API

Legal Documents

Get all legal documents with pagination

GET

/api/v1/legal-documents

Retrieve a paginated list of legal documents based on query parameters

Get all legal documents with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

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

GET /api/v1/legal-documents

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new legal document

POST

/api/v1/legal-documents

Create a new legal document with the provided data

Create a new legal document › Request Body

termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

Create a new legal document › Responses

LegalDocuments created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

POST /api/v1/legal-documents

curl --request POST \
  --url /api/v1/legal-documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}
'

shell

Show example in

Request Body Example

{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}

json

Example Responses

No example

json

application/json

Get last legal document

GET

/api/v1/legal-documents/last

Retrieve the most recent legal document

Get last legal document › Responses

Last Legal Documents detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

GET /api/v1/legal-documents/last

curl --request GET \
  --url /api/v1/legal-documents/last

shell

Show example in

Example Responses

No example

json

application/json

Get legal document by ID

GET

/api/v1/legal-documents/{id}

Retrieve a specific legal document by its ID

Get legal document by ID › path Parameters

idnumber · min: 1 · required
Id

Get legal document by ID › Responses

LegalDocuments detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

GET /api/v1/legal-documents/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a legal document

PUT

/api/v1/legal-documents/{id}

Update an existing legal document by its ID

Update a legal document › path Parameters

idnumber · min: 1 · required
Id

Update a legal document › Request Body

termsAndConditionsstring
Terms and Conditions
privacyPolicystring
Privacy Policy
termsAndConditionsVersionstring
Terms and Conditions Version
privacyPolicyVersionstring
Privacy Policy Version

Update a legal document › Responses

LegalDocuments updated

No data returned

PUT /api/v1/legal-documents/{id}

curl --request PUT \
  --url /api/v1/legal-documents/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}
'

shell

Show example in

Request Body Example

{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}

json

Example Responses

No example

plain

Delete a legal document

DELETE

/api/v1/legal-documents/{id}

Delete a legal document by its ID

Delete a legal document › path Parameters

idnumber · min: 1 · required
Id

Delete a legal document › Responses

LegalDocuments deleted

No data returned

DELETE /api/v1/legal-documents/{id}

curl --request DELETE \
  --url /api/v1/legal-documents/:id

shell

Show example in

Example Responses

No example

plain

Reset Data Auth

Brein API

Legal Documents

Get all legal documents with pagination

GET

/api/v1/legal-documents

Retrieve a paginated list of legal documents based on query parameters

Get all legal documents with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

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

GET /api/v1/legal-documents

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new legal document

POST

/api/v1/legal-documents

Create a new legal document with the provided data

Create a new legal document › Request Body

termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

Create a new legal document › Responses

LegalDocuments created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

POST /api/v1/legal-documents

curl --request POST \
  --url /api/v1/legal-documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}
'

shell

Show example in

Request Body Example

{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}

json

Example Responses

No example

json

application/json

Get last legal document

GET

/api/v1/legal-documents/last

Retrieve the most recent legal document

Get last legal document › Responses

Last Legal Documents detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

GET /api/v1/legal-documents/last

curl --request GET \
  --url /api/v1/legal-documents/last

shell

Show example in

Example Responses

No example

json

application/json

Get legal document by ID

GET

/api/v1/legal-documents/{id}

Retrieve a specific legal document by its ID

Get legal document by ID › path Parameters

idnumber · min: 1 · required
Id

Get legal document by ID › Responses

LegalDocuments detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
termsAndConditionsstring · required
Terms and Conditions
privacyPolicystring · required
Privacy Policy
termsAndConditionsVersionstring · required
Terms and Conditions Version
privacyPolicyVersionstring · required
Privacy Policy Version

GET /api/v1/legal-documents/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a legal document

PUT

/api/v1/legal-documents/{id}

Update an existing legal document by its ID

Update a legal document › path Parameters

idnumber · min: 1 · required
Id

Update a legal document › Request Body

termsAndConditionsstring
Terms and Conditions
privacyPolicystring
Privacy Policy
termsAndConditionsVersionstring
Terms and Conditions Version
privacyPolicyVersionstring
Privacy Policy Version

Update a legal document › Responses

LegalDocuments updated

No data returned

PUT /api/v1/legal-documents/{id}

curl --request PUT \
  --url /api/v1/legal-documents/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}
'

shell

Show example in

Request Body Example

{
  "termsAndConditions": "termsAndConditions",
  "privacyPolicy": "privacyPolicy",
  "termsAndConditionsVersion": "termsAndConditionsVersion",
  "privacyPolicyVersion": "privacyPolicyVersion"
}

json

Example Responses

No example

plain

Delete a legal document

DELETE

/api/v1/legal-documents/{id}

Delete a legal document by its ID

Delete a legal document › path Parameters

idnumber · min: 1 · required
Id

Delete a legal document › Responses

LegalDocuments deleted

No data returned

DELETE /api/v1/legal-documents/{id}

curl --request DELETE \
  --url /api/v1/legal-documents/:id

shell

Show example in

Example Responses

No example

plain

Reset Data Auth