Organisation
Read and update organisation settings
GET
/api/v1/organisationGet organisation
Returns the current organisation's settings and details.
Response
| Field | Type | Description |
|---|---|---|
| id | string(uuid) | |
| name | string | |
| slug | string | |
| domain | string| null | |
| logo_url | string| null | |
| country_code | string | |
| timezone | string | |
| working_days | array | |
| leave_year_type | string | |
| leave_year_start_month | integer | |
| leave_year_start_day | integer | |
| default_leave_allowance | number | |
| created_at | string(date-time) |
curl https://api.offly.net/api/v1/organisation \
-H "Authorization: Bearer YOUR_API_KEY"Try it
Do not use production API keys on shared devices. Keys are stored in memory only.
PATCH
/api/v1/organisationUpdate organisation
Updates organisation settings. Requires admin or owner role.
Request body
| Field | Type | Description |
|---|---|---|
| name | string | |
| country_code | string | |
| timezone | string | |
| working_days | array | |
| leave_year_type | string | |
| leave_year_start_month | integer | |
| leave_year_start_day | integer | |
| default_leave_allowance | number |
Response
| Field | Type | Description |
|---|---|---|
| id | string(uuid) | |
| name | string | |
| slug | string | |
| domain | string| null | |
| logo_url | string| null | |
| country_code | string | |
| timezone | string | |
| working_days | array | |
| leave_year_type | string | |
| leave_year_start_month | integer | |
| leave_year_start_day | integer | |
| default_leave_allowance | number | |
| created_at | string(date-time) |
curl -X PATCH https://api.offly.net/api/v1/organisation \
-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.