Departments

Manage departments, managers and team structures

GET/api/v1/departments

List departments

Returns all departments in the organisation.

curl https://api.offly.net/api/v1/departments \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key

POST/api/v1/departments

Create a department

Creates a new department. Requires admin or owner role.

Request body

Field	Type	Description
name*	string
manager_id	string(uuid)
default_leave_allowance	number

Response

Field	Type	Description
id	string(uuid)
name	string
manager_id	string(uuid)\| null
default_leave_allowance	number\| null
created_at	string(date-time)

curl -X POST https://api.offly.net/api/v1/departments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key

Request Body (JSON)

PATCH/api/v1/departments/{id}

Update a department

Updates a department. Requires admin or owner role.

Parameters

Name	Type	In	Description
id*	string(uuid)	path

Request body

Field	Type	Description
name	string
manager_id	string(uuid)\| null
default_leave_allowance	number\| null

Response

Field	Type	Description
id	string(uuid)
name	string
manager_id	string(uuid)\| null
default_leave_allowance	number\| null
created_at	string(date-time)

curl -X PATCH https://api.offly.net/api/v1/departments/{id} \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key

Request Body (JSON)

DELETE/api/v1/departments/{id}

Delete a department

Deletes a department. Requires admin or owner role.

Parameters

Name	Type	In	Description
id*	string(uuid)	path

curl -X DELETE https://api.offly.net/api/v1/departments/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key