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

List Workspaces

Request

Retrieves workspace records linked to the API account.

Security
APIKeyHeader
import requests

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

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 name of the workspace

Default "Workspace 1"
websitestring(Website)

The website URL of the workspace

Default "https://example.com"
clientsArray of objects(Clients)
Default []
]
Response
application/json
[
  {
    "id": "recXXXXXXXXXXXXXX",
    "createdTime": "2023-01-01T00:00:00.000Z",
    "title": "Workspace 1",
    "website": "https://example.com",
    "clients": []
  }
]

Get Workspace

Request

Get a workspace record using id

Security
APIKeyHeader
Path
idstring(Id)required
import requests

id = "YOUR_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/workspaces/" + 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 name of the workspace

Default "Workspace 1"
websitestring(Website)

The website URL of the workspace

Default "https://example.com"
clientsArray of objects(Clients)
Default []
Response
application/json
{
  "id": "recXXXXXXXXXXXXXX",
  "createdTime": "2023-01-01T00:00:00.000Z",
  "title": "Workspace 1",
  "website": "https://example.com",
  "clients": []
}

Get Tasks

Request

Get tasks using workspace id

Args: id (str): The ID of the workspace to retrieve.

Security
APIKeyHeader
Path
idstring(Id)required
import requests

id = "YOUR_id_PARAMETER"
url = "https://docs.borza.com/_mock/openapi/v1/workspaces/" + id + "/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
  }
]

Submissions

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

Operations