office

Get Many Offices

Get Many Offices

Securitybearer
Request
query Parameters
select
Array of strings

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

Items Enum: "id" "companyId" "name" "phone" "email" "timezone" "CFAR" "SCB" "SNI"
object

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

limit
integer

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

offset
integer

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

object

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

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

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

Create One Office

Create One Office

Securitybearer
Request
Request Body schema: application/json
required
name
required
string
phone
required
string
email
required
string
timezone
required
string
CFAR
required
string
SCB
required
string
SNI
required
string
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/office
Request samples
application/json
{
  • "name": "string",
  • "phone": "string",
  • "email": "string",
  • "timezone": "Africa/Abidjan",
  • "CFAR": "string",
  • "SCB": "string",
  • "SNI": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Office

Get One Office

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

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

Items Enum: "id" "companyId" "name" "phone" "email" "timezone" "CFAR" "SCB" "SNI"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

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

Update One Office

Update One Office

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
phone
string
email
string
timezone
string
CFAR
string
SCB
string
SNI
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/office/{id}
Request samples
application/json
{
  • "name": "string",
  • "phone": "string",
  • "email": "string",
  • "timezone": "Africa/Abidjan",
  • "CFAR": "string",
  • "SCB": "string",
  • "SNI": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Office

Replace One Office

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
phone
string
email
string
timezone
string
CFAR
string
SCB
string
SNI
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/office/{id}
Request samples
application/json
{
  • "name": "string",
  • "phone": "string",
  • "email": "string",
  • "timezone": "Africa/Abidjan",
  • "CFAR": "string",
  • "SCB": "string",
  • "SNI": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Office

Delete One Office

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/office/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to team