OfflyOffly
DocsAPI

Quickstart

Make your first API request in under 5 minutes.

1

Create an API key

Go to Settings → API Keys in the Offly app and click Create API Key. Give it a name and copy the key — it won't be shown again.

2

Make your first request

Test your key by listing users in your organisation:

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

List users

The response contains an array of user objects:

Response
[
  {
    "id": "8f14e45f-ceea-467f-a83c-0a06b8300123",
    "email": "sarah@acme.com",
    "first_name": "Sarah",
    "last_name": "Chen",
    "role": "member",
    "status": "active",
    "department_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "start_date": "2024-03-15",
    "created_at": "2024-03-15T10:00:00Z"
  }
]
4

Create a leave request

curl -X POST https://api.offly.net/api/v1/leave-requests \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leave_type_id": "lt_annual_leave_id",
    "start_date": "2026-07-01",
    "end_date": "2026-07-05",
    "note": "Summer holiday"
  }'
5

Listen for webhook events

Set up a webhook in Settings → Webhooks to receive real-time events when leave requests are created, approved, or cancelled. See the Webhooks guide for details.

Next steps