Create a new team

Teams API (1.0)

API for managing teams within the organization

Download OpenAPI description
teams.json
teams.yaml
Languages
Servers
Mock server
https://developer.boyahq.com/_mock/teams/
Boya API server
https://api.boyahq.com/v1/

Get all teams

Request

Headers
org_wallet_refstringrequired
curl -i -X GET \
  https://developer.boyahq.com/_mock/teams/teams \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -H 'org_wallet_ref: string'

Responses

Successful response

Bodyapplication/jsonArray [
_idstring
namestring
statusstring
reviewersArray of objects(Reviewer)
codestring
createdAtstring(date-time)
updatedAtstring(date-time)
__vnumber
updated_bystring
employee_countnumber
employeesArray of objects(Employee)
balancenumber
]
Response
application/json
[
  {
    "_id": "string",
    "name": "string",
    "status": "string",
    "reviewers": [ … ],
    "code": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "__v": 0,
    "updated_by": "string",
    "employee_count": 0,
    "employees": [ … ],
    "balance": 0
  }
]

Create a new team

Request

Bodyapplication/jsonrequired
namestringrequired
codestringrequired
statusstring
Default "ACTIVE"
curl -i -X POST \
  https://developer.boyahq.com/_mock/teams/teams \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "code": "string",
    "status": "ACTIVE"
  }'

Responses

Created

Bodyapplication/json
_idstring
namestring
statusstring
reviewersArray of objects(Reviewer)
codestring
createdAtstring(date-time)
updatedAtstring(date-time)
__vnumber
updated_bystring
employee_countnumber
employeesArray of objects(Employee)
balancenumber
Response
application/json
{
  "_id": "string",
  "name": "string",
  "status": "string",
  "reviewers": [
    { … }
  ],
  "code": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "__v": 0,
  "updated_by": "string",
  "employee_count": 0,
  "employees": [
    { … }
  ],
  "balance": 0
}

Get a specific team

Request

Path
teamIdstringrequired
curl -i -X GET \
  'https://developer.boyahq.com/_mock/teams/teams/{teamId}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
_idstring
namestring
statusstring
reviewersArray of objects(Reviewer)
codestring
createdAtstring(date-time)
updatedAtstring(date-time)
__vnumber
updated_bystring
employee_countnumber
employeesArray of objects(Employee)
balancenumber
Response
application/json
{
  "_id": "string",
  "name": "string",
  "status": "string",
  "reviewers": [
    { … }
  ],
  "code": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "__v": 0,
  "updated_by": "string",
  "employee_count": 0,
  "employees": [
    { … }
  ],
  "balance": 0
}

Update a team

Request

Path
teamIdstringrequired
Bodyapplication/jsonrequired
namestring
statusstring
curl -i -X PATCH \
  'https://developer.boyahq.com/_mock/teams/teams/{teamId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "status": "string"
  }'

Responses

Successful response

Bodyapplication/json
_idstring
namestring
statusstring
reviewersArray of objects(Reviewer)
codestring
createdAtstring(date-time)
updatedAtstring(date-time)
__vnumber
updated_bystring
employee_countnumber
employeesArray of objects(Employee)
balancenumber
Response
application/json
{
  "_id": "string",
  "name": "string",
  "status": "string",
  "reviewers": [
    { … }
  ],
  "code": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "__v": 0,
  "updated_by": "string",
  "employee_count": 0,
  "employees": [
    { … }
  ],
  "balance": 0
}

Delete a team

Request

Path
teamIdstringrequired
curl -i -X DELETE \
  'https://developer.boyahq.com/_mock/teams/teams/{teamId}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful response

Add a reviewer to a team

Request

Path
teamIdstringrequired
Bodyapplication/jsonrequired
employee_idstringrequired
namestringrequired
read_onlyboolean
Default false
curl -i -X POST \
  'https://developer.boyahq.com/_mock/teams/teams/{teamId}/reviewers' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "employee_id": "string",
    "name": "string",
    "read_only": false
  }'

Responses

Created

Bodyapplication/json
employee_idstring
namestring
read_onlyboolean
_idstring
added_onstring(date-time)
Response
application/json
{
  "employee_id": "string",
  "name": "string",
  "read_only": true,
  "_id": "string",
  "added_on": "2019-08-24T14:15:22Z"
}

Remove a reviewer from a team

Request

Path
teamIdstringrequired
reviewerIdstringrequired
curl -i -X PATCH \
  'https://developer.boyahq.com/_mock/teams/teams/{teamId}/reviewers/{reviewerId}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful response

Move employee to a team

Request

Bodyapplication/jsonrequired
team_codestringrequired
employee_idstringrequired
curl -i -X POST \
  https://developer.boyahq.com/_mock/teams/teams/addEmployee/ \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "team_code": "string",
    "employee_id": "string"
  }'

Responses

Employee Moved to Team

Bodyapplication/json
namestring
phonestring
organization_emailstring
employee_idstring
rolestring
Enum"CARD USER""REVIEWER""APPROVER"
team_codestring
keystring
balancenumber
Response
application/json
{
  "name": "string",
  "phone": "string",
  "organization_email": "string",
  "employee_id": "string",
  "role": "CARD USER",
  "team_code": "string",
  "key": "string",
  "balance": 0
}