Skip to content

Borza API (1.0)

Borza API providing various endpoints for tasks management

Overview
License
MIT
Languages
Servers
Mock server
https://docs.borza.com/_mock/openapi/
Production server
https://api.borza.com/
Testing server
https://api-testing.borza.com/

Tasks

Operations related to Tasks. Create, update, and manage tasks.

Operations

Workspaces

Operations related to Workspaces. Create, update, and manage workspaces.

Operations

Submissions

Opewrations related to Submissions. Create, update, and manage submissions.

Operations

Get Submission By Id

Request

Retrieve a submission by its ID.

Security
APIKeyHeader
Path
submission_idstring(Submission Id)required
import requests

submission_id = "YOUR_submission_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/submissions/" + submission_id

headers = {"x-api-key": "YOUR_API_KEY_HERE"}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
createdTimeCreatedtime (string) or Createdtime (null)(Createdtime)

The record creation timestamp

Example: "2023-01-01T00:00:00.000Z"
Any of:

The record creation timestamp

string(Createdtime)
nameName (string) or Name (null)(Name)

The name of the submission

Default ""
Any of:

The name of the submission

string(Name)
Default ""
participantobject(Participant)required

The person assigned to the task

participant.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
participant.​emailstring(Email)

The email address of the user

Default ""
participant.​namestring(Name)

The name of the user

Default ""
task_idTask Id (string) or Task Id (null)(Task Id)

The ID of the task

Default ""
Any of:

The ID of the task

string(Task Id)
Default ""
notesNotes (string) or Notes (null)(Notes)

Additional notes about the submission

Default ""
Any of:

Additional notes about the submission

string(Notes)
Default ""
statusSUBMISSION_STATUS (string) or null

Current status of the submission

Default "Awaiting Review"
Any of:

Current status of the submission

string(SUBMISSION_STATUS)
Default "Awaiting Review"
Enum"Awaiting Review""Pending""Approved""Rejected""Completed"
categoryCategory (string) or Category (null)(Category)

Category of the task

Default ""
Any of:

Category of the task

string(Category)
Default ""
completion_codeCompletion Code (string) or Completion Code (null)(Completion Code)

Code indicating the completion status

Default ""
Any of:

Code indicating the completion status

string(Completion Code)
Default ""
apply_bonusApply Bonus (boolean) or Apply Bonus (null)(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
Any of:

Indicates whether the task has an additional bonus applied.

boolean(Apply Bonus)
Default false
bonus_amountBonus Amount (integer) or Bonus Amount (null)(Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Any of:

Specifies the total bonus amount in currency format.

integer(Bonus Amount)
Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "name": "",
  "participant": {
    "id": "recXXXXXXXXXXXXXX",
    "email": "",
    "name": ""
  },
  "task_id": "",
  "notes": "",
  "status": "Awaiting Review",
  "category": "",
  "completion_code": "",
  "apply_bonus": false,
  "bonus_amount": 0
}

Get Submissions By Task Id

Request

Retrieve submission by assiociated task ID.

Security
APIKeyHeader
Path
task_idstring(Task Id)required
import requests

task_id = "YOUR_task_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/submissions/task/" + task_id

headers = {"x-api-key": "YOUR_API_KEY_HERE"}

response = requests.get(url, headers=headers)

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/jsonArray [
idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
createdTimeCreatedtime (string) or Createdtime (null)(Createdtime)

The record creation timestamp

Example: "2023-01-01T00:00:00.000Z"
Any of:

The record creation timestamp

string(Createdtime)
nameName (string) or Name (null)(Name)

The name of the submission

Default ""
Any of:

The name of the submission

string(Name)
Default ""
participantobject(Participant)required

The person assigned to the task

participant.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
participant.​emailstring(Email)

The email address of the user

Default ""
participant.​namestring(Name)

The name of the user

Default ""
task_idTask Id (string) or Task Id (null)(Task Id)

The ID of the task

Default ""
Any of:

The ID of the task

string(Task Id)
Default ""
notesNotes (string) or Notes (null)(Notes)

Additional notes about the submission

Default ""
Any of:

Additional notes about the submission

string(Notes)
Default ""
statusSUBMISSION_STATUS (string) or null

Current status of the submission

Default "Awaiting Review"
Any of:

Current status of the submission

string(SUBMISSION_STATUS)
Default "Awaiting Review"
Enum"Awaiting Review""Pending""Approved""Rejected""Completed"
categoryCategory (string) or Category (null)(Category)

Category of the task

Default ""
Any of:

Category of the task

string(Category)
Default ""
completion_codeCompletion Code (string) or Completion Code (null)(Completion Code)

Code indicating the completion status

Default ""
Any of:

Code indicating the completion status

string(Completion Code)
Default ""
apply_bonusApply Bonus (boolean) or Apply Bonus (null)(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
Any of:

Indicates whether the task has an additional bonus applied.

boolean(Apply Bonus)
Default false
bonus_amountBonus Amount (integer) or Bonus Amount (null)(Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Any of:

Specifies the total bonus amount in currency format.

integer(Bonus Amount)
Default 0
]
Response
application/json
[
  {
    "id": "recXXXXXXXXXXXXXX",
    "createdTime": "2023-01-01T00:00:00.000Z",
    "name": "",
    "participant": { … },
    "task_id": "",
    "notes": "",
    "status": "Awaiting Review",
    "category": "",
    "completion_code": "",
    "apply_bonus": false,
    "bonus_amount": 0
  }
]

Approve Submission

Request

Approve a submission by updating its completion status to 'Approved'.

If a bonus amount is provided, it will be added to the submission record.

Security
APIKeyHeader
Path
submission_idstring(Submission Id)required
Query
bonus_amountBonus Amount (integer) or Bonus Amount (null)(Bonus Amount)required
Any of:
integer(Bonus Amount)
import requests

submission_id = "YOUR_submission_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/submissions/" + submission_id + "/approve"

query = {
  "bonus_amount": "0"
}

headers = {"x-api-key": "YOUR_API_KEY_HERE"}

response = requests.post(url, headers=headers, params=query)

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
createdTimeCreatedtime (string) or Createdtime (null)(Createdtime)

The record creation timestamp

Example: "2023-01-01T00:00:00.000Z"
Any of:

The record creation timestamp

string(Createdtime)
nameName (string) or Name (null)(Name)

The name of the submission

Default ""
Any of:

The name of the submission

string(Name)
Default ""
participantobject(Participant)required

The person assigned to the task

participant.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
participant.​emailstring(Email)

The email address of the user

Default ""
participant.​namestring(Name)

The name of the user

Default ""
task_idTask Id (string) or Task Id (null)(Task Id)

The ID of the task

Default ""
Any of:

The ID of the task

string(Task Id)
Default ""
notesNotes (string) or Notes (null)(Notes)

Additional notes about the submission

Default ""
Any of:

Additional notes about the submission

string(Notes)
Default ""
statusSUBMISSION_STATUS (string) or null

Current status of the submission

Default "Awaiting Review"
Any of:

Current status of the submission

string(SUBMISSION_STATUS)
Default "Awaiting Review"
Enum"Awaiting Review""Pending""Approved""Rejected""Completed"
categoryCategory (string) or Category (null)(Category)

Category of the task

Default ""
Any of:

Category of the task

string(Category)
Default ""
completion_codeCompletion Code (string) or Completion Code (null)(Completion Code)

Code indicating the completion status

Default ""
Any of:

Code indicating the completion status

string(Completion Code)
Default ""
apply_bonusApply Bonus (boolean) or Apply Bonus (null)(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
Any of:

Indicates whether the task has an additional bonus applied.

boolean(Apply Bonus)
Default false
bonus_amountBonus Amount (integer) or Bonus Amount (null)(Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Any of:

Specifies the total bonus amount in currency format.

integer(Bonus Amount)
Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "name": "",
  "participant": {
    "id": "recXXXXXXXXXXXXXX",
    "email": "",
    "name": ""
  },
  "task_id": "",
  "notes": "",
  "status": "Awaiting Review",
  "category": "",
  "completion_code": "",
  "apply_bonus": false,
  "bonus_amount": 0
}

Reject Submission

Request

Reject a submission by updating its completion status to 'Rejected'.

Security
APIKeyHeader
Path
submission_idstring(Submission Id)required
import requests

submission_id = "YOUR_submission_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/submissions/" + submission_id + "/reject"

headers = {"x-api-key": "YOUR_API_KEY_HERE"}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
createdTimeCreatedtime (string) or Createdtime (null)(Createdtime)

The record creation timestamp

Example: "2023-01-01T00:00:00.000Z"
Any of:

The record creation timestamp

string(Createdtime)
nameName (string) or Name (null)(Name)

The name of the submission

Default ""
Any of:

The name of the submission

string(Name)
Default ""
participantobject(Participant)required

The person assigned to the task

participant.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
participant.​emailstring(Email)

The email address of the user

Default ""
participant.​namestring(Name)

The name of the user

Default ""
task_idTask Id (string) or Task Id (null)(Task Id)

The ID of the task

Default ""
Any of:

The ID of the task

string(Task Id)
Default ""
notesNotes (string) or Notes (null)(Notes)

Additional notes about the submission

Default ""
Any of:

Additional notes about the submission

string(Notes)
Default ""
statusSUBMISSION_STATUS (string) or null

Current status of the submission

Default "Awaiting Review"
Any of:

Current status of the submission

string(SUBMISSION_STATUS)
Default "Awaiting Review"
Enum"Awaiting Review""Pending""Approved""Rejected""Completed"
categoryCategory (string) or Category (null)(Category)

Category of the task

Default ""
Any of:

Category of the task

string(Category)
Default ""
completion_codeCompletion Code (string) or Completion Code (null)(Completion Code)

Code indicating the completion status

Default ""
Any of:

Code indicating the completion status

string(Completion Code)
Default ""
apply_bonusApply Bonus (boolean) or Apply Bonus (null)(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
Any of:

Indicates whether the task has an additional bonus applied.

boolean(Apply Bonus)
Default false
bonus_amountBonus Amount (integer) or Bonus Amount (null)(Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Any of:

Specifies the total bonus amount in currency format.

integer(Bonus Amount)
Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "name": "",
  "participant": {
    "id": "recXXXXXXXXXXXXXX",
    "email": "",
    "name": ""
  },
  "task_id": "",
  "notes": "",
  "status": "Awaiting Review",
  "category": "",
  "completion_code": "",
  "apply_bonus": false,
  "bonus_amount": 0
}

Await Review Submission

Request

Await review of a submission by updating its completion status to 'Awaiting Review'.

Security
APIKeyHeader
Path
submission_idstring(Submission Id)required
import requests

submission_id = "YOUR_submission_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/submissions/" + submission_id + "/await-review"

headers = {"x-api-key": "YOUR_API_KEY_HERE"}

response = requests.post(url, headers=headers)

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
createdTimeCreatedtime (string) or Createdtime (null)(Createdtime)

The record creation timestamp

Example: "2023-01-01T00:00:00.000Z"
Any of:

The record creation timestamp

string(Createdtime)
nameName (string) or Name (null)(Name)

The name of the submission

Default ""
Any of:

The name of the submission

string(Name)
Default ""
participantobject(Participant)required

The person assigned to the task

participant.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
participant.​emailstring(Email)

The email address of the user

Default ""
participant.​namestring(Name)

The name of the user

Default ""
task_idTask Id (string) or Task Id (null)(Task Id)

The ID of the task

Default ""
Any of:

The ID of the task

string(Task Id)
Default ""
notesNotes (string) or Notes (null)(Notes)

Additional notes about the submission

Default ""
Any of:

Additional notes about the submission

string(Notes)
Default ""
statusSUBMISSION_STATUS (string) or null

Current status of the submission

Default "Awaiting Review"
Any of:

Current status of the submission

string(SUBMISSION_STATUS)
Default "Awaiting Review"
Enum"Awaiting Review""Pending""Approved""Rejected""Completed"
categoryCategory (string) or Category (null)(Category)

Category of the task

Default ""
Any of:

Category of the task

string(Category)
Default ""
completion_codeCompletion Code (string) or Completion Code (null)(Completion Code)

Code indicating the completion status

Default ""
Any of:

Code indicating the completion status

string(Completion Code)
Default ""
apply_bonusApply Bonus (boolean) or Apply Bonus (null)(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
Any of:

Indicates whether the task has an additional bonus applied.

boolean(Apply Bonus)
Default false
bonus_amountBonus Amount (integer) or Bonus Amount (null)(Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Any of:

Specifies the total bonus amount in currency format.

integer(Bonus Amount)
Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "name": "",
  "participant": {
    "id": "recXXXXXXXXXXXXXX",
    "email": "",
    "name": ""
  },
  "task_id": "",
  "notes": "",
  "status": "Awaiting Review",
  "category": "",
  "completion_code": "",
  "apply_bonus": false,
  "bonus_amount": 0
}