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

List Tasks

Request

Retrieve a list of all tasks

Security
APIKeyHeader
import requests

url = "https://docs.borza.com/_mock/openapi/v1/tasks"

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)
titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

number(Budget)
Default 20
clientobject(LinkedClient)required

The client user associated with the task

client.​idstring(Id)required
Example: "rec12345"
client.​namestring(Name)
Default "John Doe"
client.​emailstring(Email)
Default "example@domain.com"
workspaceobject(LinkedWorkspace)required

The workspace associated with the task

workspace.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
workspace.​titlestring(Title)

The name of the workspace

Default "Workspace 1"
statusTaskStatus (string) or null

The current publish status of the task

Default "Draft"
Any of:

The current publish status of the task

string(TaskStatus)
Default "Draft"
Enum"Draft""Published""Unavailable""Invite only"
categorystring(Category)required

The general category of the task

submission_idsArray of strings(Submission Ids)

The submissions for the task

Default []
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default ""
Any of:

The categories of the task

string(Task Category)
Default ""
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ""
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default ""
external_study_urlstring(External Study Url)

The URL where the task is to be performed.

Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 0
Any of:

The estimated time to complete the task, in minutes.

integer(Task Estimation)
Default 0
apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
]
Response
application/json
[
  {
    "id": "recXXXXXXXXXXXXXX",
    "createdTime": "2023-01-01T00:00:00.000Z",
    "title": "Survey for A/B Video",
    "description": "Task",
    "budget": 20,
    "client": { … },
    "workspace": { … },
    "status": "Draft",
    "category": "string",
    "submission_ids": [],
    "talent_filters": [],
    "location": [],
    "language": [],
    "talent_count_requirement": 0,
    "device_requirements": [],
    "other_requirements": [],
    "task_category": "",
    "completion_path": "",
    "external_study_url": "",
    "task_estimation": 0,
    "apply_bonus": false,
    "total_bonus_amount": 0
  }
]

Create Task

Request

Create a draft task

Security
APIKeyHeader
Bodyapplication/jsonrequired
client_idstring(Client Id)required

The ID of the client user associated with the task

workspace_idstring(Workspace Id)required

The ID of the workspace associated with the task

titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetnumber(Budget)> 0

The reward for completing the task in dollars

Default 20
external_study_urlstring(External Study Url)required

The URL where the task is to be performed.

task_estimationinteger(Task Estimation)> 0required

The estimated time to complete the task, in minutes.

talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementinteger(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categorystring(Task Category)required

The categories of the task

completion_pathstring(Completion Path)required

The workflow for completing the task (e.g., Manual review or Approve and pay).

apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
import requests

url = "https://docs.borza.com/_mock/openapi/v1/tasks"

payload = {
  "client_id": "string",
  "workspace_id": "string",
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "external_study_url": "string",
  "task_estimation": 0,
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 0,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "string",
  "completion_path": "string",
  "apply_bonus": False,
  "total_bonus_amount": 0
}

headers = {
  "Content-Type": "application/json",
  "x-api-key": "YOUR_API_KEY_HERE"
}

response = requests.post(url, json=payload, 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)
titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

number(Budget)
Default 20
clientobject(LinkedClient)required

The client user associated with the task

client.​idstring(Id)required
Example: "rec12345"
client.​namestring(Name)
Default "John Doe"
client.​emailstring(Email)
Default "example@domain.com"
workspaceobject(LinkedWorkspace)required

The workspace associated with the task

workspace.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
workspace.​titlestring(Title)

The name of the workspace

Default "Workspace 1"
statusTaskStatus (string) or null

The current publish status of the task

Default "Draft"
Any of:

The current publish status of the task

string(TaskStatus)
Default "Draft"
Enum"Draft""Published""Unavailable""Invite only"
categorystring(Category)required

The general category of the task

submission_idsArray of strings(Submission Ids)

The submissions for the task

Default []
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default ""
Any of:

The categories of the task

string(Task Category)
Default ""
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ""
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default ""
external_study_urlstring(External Study Url)

The URL where the task is to be performed.

Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 0
Any of:

The estimated time to complete the task, in minutes.

integer(Task Estimation)
Default 0
apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "client": {
    "id": "rec12345",
    "name": "John Doe",
    "email": "example@domain.com"
  },
  "workspace": {
    "id": "recXXXXXXXXXXXXXX",
    "title": "Workspace 1"
  },
  "status": "Draft",
  "category": "string",
  "submission_ids": [],
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 0,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "",
  "completion_path": "",
  "external_study_url": "",
  "task_estimation": 0,
  "apply_bonus": false,
  "total_bonus_amount": 0
}

List Filters

Request

Retrieve a list of all task filters

Security
APIKeyHeader
import requests

url = "https://docs.borza.com/_mock/openapi/v1/tasks/filters"

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

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

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task.

Default []
languageArray of strings(Language)

The languages required for the task

Default []
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryArray of strings(Task Category)

The categories of the task

Default ["Survey"]
completion_pathArray of strings(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ["Survey"]
Response
application/json
{
  "talent_filters": [],
  "location": [],
  "language": [],
  "device_requirements": [],
  "other_requirements": [],
  "task_category": [
    "Survey"
  ],
  "completion_path": [
    "Survey"
  ]
}

Get Task

Request

Retrieve a single task by its 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/tasks/" + 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/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)
titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

number(Budget)
Default 20
clientobject(LinkedClient)required

The client user associated with the task

client.​idstring(Id)required
Example: "rec12345"
client.​namestring(Name)
Default "John Doe"
client.​emailstring(Email)
Default "example@domain.com"
workspaceobject(LinkedWorkspace)required

The workspace associated with the task

workspace.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
workspace.​titlestring(Title)

The name of the workspace

Default "Workspace 1"
statusTaskStatus (string) or null

The current publish status of the task

Default "Draft"
Any of:

The current publish status of the task

string(TaskStatus)
Default "Draft"
Enum"Draft""Published""Unavailable""Invite only"
categorystring(Category)required

The general category of the task

submission_idsArray of strings(Submission Ids)

The submissions for the task

Default []
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default ""
Any of:

The categories of the task

string(Task Category)
Default ""
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ""
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default ""
external_study_urlstring(External Study Url)

The URL where the task is to be performed.

Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 0
Any of:

The estimated time to complete the task, in minutes.

integer(Task Estimation)
Default 0
apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "client": {
    "id": "rec12345",
    "name": "John Doe",
    "email": "example@domain.com"
  },
  "workspace": {
    "id": "recXXXXXXXXXXXXXX",
    "title": "Workspace 1"
  },
  "status": "Draft",
  "category": "string",
  "submission_ids": [],
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 0,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "",
  "completion_path": "",
  "external_study_url": "",
  "task_estimation": 0,
  "apply_bonus": false,
  "total_bonus_amount": 0
}

Full Update Task

Request

Full update an existing task by its ID

Security
APIKeyHeader
Path
task_idstring(Task Id)required
Bodyapplication/jsonrequired
titleTitle (string) or Title (null)(Title)

The title of the task

Default "Survey for A/B Video"
Any of:

The title of the task

string(Title)
Default "Survey for A/B Video"
descriptionDescription (string) or Description (null)(Description)

A detailed description of the task

Default "Task"
Any of:

A detailed description of the task

string(Description)
Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

> 0
number(Budget)> 0
Default 20
external_study_urlExternal Study Url (string) or External Study Url (null)(External Study Url)

The URL where the task is to be performed.

Default ""
Any of:

The URL where the task is to be performed.

string(External Study Url)
Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 10
Any of:

The estimated time to complete the task, in minutes.

> 0
integer(Task Estimation)> 0
Default 10
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of Location (strings) or Location (null)(Location)

The location of the user performing the task. (Refer to the Task filters endpoint)

Default []
Any of:

The location of the user performing the task. (Refer to the Task filters endpoint)

languageArray of Language (strings) or Language (null)(Language)

The languages required for the task

Default []
Any of:

The languages required for the task

talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 1
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 1
device_requirementsArray of Device Requirements (strings) or Device Requirements (null)(Device Requirements)

The device requirements for the task

Default []
Any of:

The device requirements for the task

other_requirementsArray of Other Requirements (strings) or Other Requirements (null)(Other Requirements)

Additional peripherals or tools required for the task.

Default []
Any of:

Additional peripherals or tools required for the task.

task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default "Survey"
Any of:

The categories of the task

string(Task Category)
Default "Survey"
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default "Manual review"
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default "Manual review"
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
total_bonus_amountTotal Bonus Amount (number) or Total Bonus Amount (null)(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Any of:

Specifies the total bonus amount in currency format.

number(Total Bonus Amount)
Default 0
import requests

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

payload = {
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "external_study_url": "",
  "task_estimation": 10,
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 1,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "Survey",
  "completion_path": "Manual review",
  "apply_bonus": False,
  "total_bonus_amount": 0
}

headers = {
  "Content-Type": "application/json",
  "x-api-key": "YOUR_API_KEY_HERE"
}

response = requests.put(url, json=payload, 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)
titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

number(Budget)
Default 20
clientobject(LinkedClient)required

The client user associated with the task

client.​idstring(Id)required
Example: "rec12345"
client.​namestring(Name)
Default "John Doe"
client.​emailstring(Email)
Default "example@domain.com"
workspaceobject(LinkedWorkspace)required

The workspace associated with the task

workspace.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
workspace.​titlestring(Title)

The name of the workspace

Default "Workspace 1"
statusTaskStatus (string) or null

The current publish status of the task

Default "Draft"
Any of:

The current publish status of the task

string(TaskStatus)
Default "Draft"
Enum"Draft""Published""Unavailable""Invite only"
categorystring(Category)required

The general category of the task

submission_idsArray of strings(Submission Ids)

The submissions for the task

Default []
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default ""
Any of:

The categories of the task

string(Task Category)
Default ""
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ""
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default ""
external_study_urlstring(External Study Url)

The URL where the task is to be performed.

Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 0
Any of:

The estimated time to complete the task, in minutes.

integer(Task Estimation)
Default 0
apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "client": {
    "id": "rec12345",
    "name": "John Doe",
    "email": "example@domain.com"
  },
  "workspace": {
    "id": "recXXXXXXXXXXXXXX",
    "title": "Workspace 1"
  },
  "status": "Draft",
  "category": "string",
  "submission_ids": [],
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 0,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "",
  "completion_path": "",
  "external_study_url": "",
  "task_estimation": 0,
  "apply_bonus": false,
  "total_bonus_amount": 0
}

Partial Update Task

Request

Partial update an existing task by its ID

Security
APIKeyHeader
Path
task_idstring(Task Id)required
Bodyapplication/jsonrequired
object(Payload)
import requests

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

payload = {}

headers = {
  "Content-Type": "application/json",
  "x-api-key": "YOUR_API_KEY_HERE"
}

response = requests.patch(url, json=payload, 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)
titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

number(Budget)
Default 20
clientobject(LinkedClient)required

The client user associated with the task

client.​idstring(Id)required
Example: "rec12345"
client.​namestring(Name)
Default "John Doe"
client.​emailstring(Email)
Default "example@domain.com"
workspaceobject(LinkedWorkspace)required

The workspace associated with the task

workspace.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
workspace.​titlestring(Title)

The name of the workspace

Default "Workspace 1"
statusTaskStatus (string) or null

The current publish status of the task

Default "Draft"
Any of:

The current publish status of the task

string(TaskStatus)
Default "Draft"
Enum"Draft""Published""Unavailable""Invite only"
categorystring(Category)required

The general category of the task

submission_idsArray of strings(Submission Ids)

The submissions for the task

Default []
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default ""
Any of:

The categories of the task

string(Task Category)
Default ""
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ""
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default ""
external_study_urlstring(External Study Url)

The URL where the task is to be performed.

Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 0
Any of:

The estimated time to complete the task, in minutes.

integer(Task Estimation)
Default 0
apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "client": {
    "id": "rec12345",
    "name": "John Doe",
    "email": "example@domain.com"
  },
  "workspace": {
    "id": "recXXXXXXXXXXXXXX",
    "title": "Workspace 1"
  },
  "status": "Draft",
  "category": "string",
  "submission_ids": [],
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 0,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "",
  "completion_path": "",
  "external_study_url": "",
  "task_estimation": 0,
  "apply_bonus": false,
  "total_bonus_amount": 0
}

Close Api

Request

Close a task by updating its status to 'Unavailable'.

Security
APIKeyHeader
Path
task_idstring(Task Id)required
import requests

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

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

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

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

List Task Submissions

Request

Retrieve all submissions for a specific task.

Security
APIKeyHeader
Path
task_idstring(Task Id)required
import requests

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

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
  }
]

Pause Task

Request

Pause a task by updating its status to 'Draft'.

Security
APIKeyHeader
Path
task_idstring(Task Id)required
import requests

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

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

response = requests.put(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)
titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

number(Budget)
Default 20
clientobject(LinkedClient)required

The client user associated with the task

client.​idstring(Id)required
Example: "rec12345"
client.​namestring(Name)
Default "John Doe"
client.​emailstring(Email)
Default "example@domain.com"
workspaceobject(LinkedWorkspace)required

The workspace associated with the task

workspace.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
workspace.​titlestring(Title)

The name of the workspace

Default "Workspace 1"
statusTaskStatus (string) or null

The current publish status of the task

Default "Draft"
Any of:

The current publish status of the task

string(TaskStatus)
Default "Draft"
Enum"Draft""Published""Unavailable""Invite only"
categorystring(Category)required

The general category of the task

submission_idsArray of strings(Submission Ids)

The submissions for the task

Default []
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default ""
Any of:

The categories of the task

string(Task Category)
Default ""
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ""
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default ""
external_study_urlstring(External Study Url)

The URL where the task is to be performed.

Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 0
Any of:

The estimated time to complete the task, in minutes.

integer(Task Estimation)
Default 0
apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "client": {
    "id": "rec12345",
    "name": "John Doe",
    "email": "example@domain.com"
  },
  "workspace": {
    "id": "recXXXXXXXXXXXXXX",
    "title": "Workspace 1"
  },
  "status": "Draft",
  "category": "string",
  "submission_ids": [],
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 0,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "",
  "completion_path": "",
  "external_study_url": "",
  "task_estimation": 0,
  "apply_bonus": false,
  "total_bonus_amount": 0
}

Publish Task

Request

Publish a task by updating its publish status

Security
APIKeyHeader
Path
task_idstring(Task Id)required
import requests

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

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)
titlestring(Title)

The title of the task

Default "Survey for A/B Video"
descriptionstring(Description)

A detailed description of the task

Default "Task"
budgetBudget (number) or Budget (null)(Budget)

The reward for completing the task in dollars

Default 20
Any of:

The reward for completing the task in dollars

number(Budget)
Default 20
clientobject(LinkedClient)required

The client user associated with the task

client.​idstring(Id)required
Example: "rec12345"
client.​namestring(Name)
Default "John Doe"
client.​emailstring(Email)
Default "example@domain.com"
workspaceobject(LinkedWorkspace)required

The workspace associated with the task

workspace.​idId (string) or Id (null)(Id)
Example: "recXXXXXXXXXXXXXX"
Any of:
string(Id)
workspace.​titlestring(Title)

The name of the workspace

Default "Workspace 1"
statusTaskStatus (string) or null

The current publish status of the task

Default "Draft"
Any of:

The current publish status of the task

string(TaskStatus)
Default "Draft"
Enum"Draft""Published""Unavailable""Invite only"
categorystring(Category)required

The general category of the task

submission_idsArray of strings(Submission Ids)

The submissions for the task

Default []
talent_filtersArray of strings(Talent Filters)

This field will contain an array of specific options that describe accessibility considerations or work preferences of talents.

Default []
locationArray of strings(Location)

The location of the user performing the task. (Refer to the filters API)

Default []
languageArray of strings(Language)

The languages required for the task

Default []
talent_count_requirementTalent Count Requirement (integer) or Talent Count Requirement (null)(Talent Count Requirement)

The estimated number of talents required for the task

Default 0
Any of:

The estimated number of talents required for the task

integer(Talent Count Requirement)
Default 0
device_requirementsArray of strings(Device Requirements)

The device requirements for the task

Default []
other_requirementsArray of strings(Other Requirements)

Additional peripherals or tools required for the task.

Default []
task_categoryTask Category (string) or Task Category (null)(Task Category)

The categories of the task

Default ""
Any of:

The categories of the task

string(Task Category)
Default ""
completion_pathCompletion Path (string) or Completion Path (null)(Completion Path)

The workflow for completing the task (e.g., Manual review or Approve and pay).

Default ""
Any of:

The workflow for completing the task (e.g., Manual review or Approve and pay).

string(Completion Path)
Default ""
external_study_urlstring(External Study Url)

The URL where the task is to be performed.

Default ""
task_estimationTask Estimation (integer) or Task Estimation (null)(Task Estimation)

The estimated time to complete the task, in minutes.

Default 0
Any of:

The estimated time to complete the task, in minutes.

integer(Task Estimation)
Default 0
apply_bonusboolean(Apply Bonus)

Indicates whether the task has an additional bonus applied.

Default false
total_bonus_amountnumber(Total Bonus Amount)

Specifies the total bonus amount in currency format.

Default 0
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "title": "Survey for A/B Video",
  "description": "Task",
  "budget": 20,
  "client": {
    "id": "rec12345",
    "name": "John Doe",
    "email": "example@domain.com"
  },
  "workspace": {
    "id": "recXXXXXXXXXXXXXX",
    "title": "Workspace 1"
  },
  "status": "Draft",
  "category": "string",
  "submission_ids": [],
  "talent_filters": [],
  "location": [],
  "language": [],
  "talent_count_requirement": 0,
  "device_requirements": [],
  "other_requirements": [],
  "task_category": "",
  "completion_path": "",
  "external_study_url": "",
  "task_estimation": 0,
  "apply_bonus": false,
  "total_bonus_amount": 0
}

Calculate Estimate

Request

Calculate cost estimate for a task:

  • budget_per_task: base pay per talent
  • bonus: bonus per talent
  • participants: expected number of talents
Security
APIKeyHeader
Bodyapplication/jsonrequired
budget_per_tasknumber(Budget Per Task)required
bonusnumber(Bonus)required
participantsinteger(Participants)required
import requests

url = "https://docs.borza.com/_mock/openapi/v1/tasks/estimate/calculate"

payload = {
  "budget_per_task": 0,
  "bonus": 0,
  "participants": 0
}

headers = {
  "Content-Type": "application/json",
  "x-api-key": "YOUR_API_KEY_HERE"
}

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

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
budget_per_tasknumber(Budget Per Task)required
bonusnumber(Bonus)required
participantsinteger(Participants)required
total_pay_per_talentnumber(Total Pay Per Talent)required
platform_fee_percentnumber(Platform Fee Percent)
Default 0.229
platform_fee_amountnumber(Platform Fee Amount)required
vat_percentnumber(Vat Percent)
Default 0
vat_amountnumber(Vat Amount)required
cost_per_talentnumber(Cost Per Talent)required
final_cost_estimatenumber(Final Cost Estimate)required
currencystring(Currency)
Default "USD"
Response
application/json
{
  "budget_per_task": 0,
  "bonus": 0,
  "participants": 0,
  "total_pay_per_talent": 0,
  "platform_fee_percent": 0.229,
  "platform_fee_amount": 0,
  "vat_percent": 0,
  "vat_amount": 0,
  "cost_per_talent": 0,
  "final_cost_estimate": 0,
  "currency": "USD"
}

Get Task Cost Estimate

Request

Retrieve the cost estimate fields stored for a specific task. This endpoint returns the fields exactly as saved (no calculations).

Security
APIKeyHeader
Path
task_idstring(Task Id)required
import requests

task_id = "YOUR_task_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/tasks/" + task_id + "/cost-estimate"

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

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

data = response.json()
print(data)

Responses

Successful Response

Bodyapplication/json
task_idstring(Task Id)required
participantsinteger(Participants)required
budget_per_tasknumber(Budget Per Task)required
bonusnumber(Bonus)required
total_pay_per_talentnumber(Total Pay Per Talent)required
platform_fee_amountnumber(Platform Fee Amount)required
vat_amountnumber(Vat Amount)required
cost_per_talentnumber(Cost Per Talent)required
final_cost_estimatenumber(Final Cost Estimate)required
currencystring(Currency)
Default "USD"
Response
application/json
{
  "task_id": "string",
  "participants": 0,
  "budget_per_task": 0,
  "bonus": 0,
  "total_pay_per_talent": 0,
  "platform_fee_amount": 0,
  "vat_amount": 0,
  "cost_per_talent": 0,
  "final_cost_estimate": 0,
  "currency": "USD"
}

Workspaces

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

Operations

Submissions

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

Operations