Users
Read and manage employee data
GET
/api/v1/usersList users
Returns all users in the organisation. Includes active, pending and archived employees.
Parameters
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| status | string | query | Filter by user status |
curl https://api.offly.net/api/v1/users \
-H "Authorization: Bearer YOUR_API_KEY"Try it
Do not use production API keys on shared devices. Keys are stored in memory only.
POST
/api/v1/usersCreate a user
Creates a new employee in the organisation. Requires admin or owner role.
Request body
| Field | Type | Description |
|---|---|---|
| email* | string(email) | |
| first_name* | string | |
| last_name* | string | |
| role | string | |
| department_id | string(uuid) | |
| manager_id | string(uuid) | |
| job_title | string | |
| start_date | string(date) | |
| working_days | array |
Response
| Field | Type | Description |
|---|---|---|
| id | string(uuid) | |
| string(email) | ||
| first_name | string | |
| last_name | string | |
| role | string | |
| status | string | |
| department_id | string(uuid)| null | |
| manager_id | string(uuid)| null | |
| job_title | string| null | |
| start_date | string(date)| null | |
| working_days | array | |
| public_holiday_country_code | string| null | |
| avatar_url | string| null | |
| is_active | boolean | |
| created_at | string(date-time) | |
| updated_at | string(date-time) |
curl -X POST https://api.offly.net/api/v1/users \
-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.
GET
/api/v1/users/{id}Get a user
Returns a single user by ID.
Parameters
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| id* | string(uuid) | path |
Response
| Field | Type | Description |
|---|---|---|
| id | string(uuid) | |
| string(email) | ||
| first_name | string | |
| last_name | string | |
| role | string | |
| status | string | |
| department_id | string(uuid)| null | |
| manager_id | string(uuid)| null | |
| job_title | string| null | |
| start_date | string(date)| null | |
| working_days | array | |
| public_holiday_country_code | string| null | |
| avatar_url | string| null | |
| is_active | boolean | |
| created_at | string(date-time) | |
| updated_at | string(date-time) |
curl https://api.offly.net/api/v1/users/{id} \
-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/users/{id}Update a user
Updates an existing user. Requires admin or owner role.
Parameters
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| id* | string(uuid) | path |
Request body
| Field | Type | Description |
|---|---|---|
| first_name | string | |
| last_name | string | |
| role | string | |
| department_id | string(uuid)| null | |
| manager_id | string(uuid)| null | |
| job_title | string | |
| start_date | string(date) | |
| working_days | array |
Response
| Field | Type | Description |
|---|---|---|
| id | string(uuid) | |
| string(email) | ||
| first_name | string | |
| last_name | string | |
| role | string | |
| status | string | |
| department_id | string(uuid)| null | |
| manager_id | string(uuid)| null | |
| job_title | string| null | |
| start_date | string(date)| null | |
| working_days | array | |
| public_holiday_country_code | string| null | |
| avatar_url | string| null | |
| is_active | boolean | |
| created_at | string(date-time) | |
| updated_at | string(date-time) |
curl -X PATCH https://api.offly.net/api/v1/users/{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.
DELETE
/api/v1/users/{id}Delete a user
Soft-deletes a user (archives them). Requires admin or owner role.
Parameters
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| id* | string(uuid) | path |
curl -X DELETE https://api.offly.net/api/v1/users/{id} \
-H "Authorization: Bearer YOUR_API_KEY"Try it
Do not use production API keys on shared devices. Keys are stored in memory only.