team

Get Many Teams

Get Many Teams

Securitybearer
Request
query Parameters
select
Array of strings

Select Team fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "name" "description" "bgColor" "fgColor"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Teams. (e.g. limit=20)

offset
integer

Offset amount of received Teams. (e.g. offset=20)

object

Sort received Teams by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/team
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": { }
}

Create One Team

Create One Team

Securitybearer
Request
Request Body schema: application/json
required
name
required
string
description
string
bgColor
required
string
fgColor
required
string
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/team
Request samples
application/json
{
  • "name": "Team 1",
  • "description": "string",
  • "bgColor": "#dee9fe",
  • "fgColor": "#032f83"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Team

Get One Team

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Team fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "name" "description" "bgColor" "fgColor"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/team/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}

Update One Team

Update One Team

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
description
string
bgColor
string
fgColor
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/team/{id}
Request samples
application/json
{
  • "name": "Team 1",
  • "description": "string",
  • "bgColor": "#dee9fe",
  • "fgColor": "#032f83"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Team

Replace One Team

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
description
string
bgColor
string
fgColor
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/team/{id}
Request samples
application/json
{
  • "name": "Team 1",
  • "description": "string",
  • "bgColor": "#dee9fe",
  • "fgColor": "#032f83"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Team

Delete One Team

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/team/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to employee-team-reference