Finnish Holiday calendar API

Login

curl -d '{"username":"<user>","password":"<pass>"}' -H 'Content-Type: application/json' https://holiday-calendar.fi/api/login

Acquire Bearer token. Lifetime 2 hours.

Request body

• username Username or user email
• password Password

{"username": "user", "password": "pass"}

Result

Bearer token (JSON encoded string)

"b480bb7f71c7a61a80d33bfcf42466bb"

Logout

curl -XPOST -H 'Authorization: Bearer <token>' https://holiday-calender/api/logout

Expires current Bearer token

Request body

None

Result

No content

Register

curl -d '{"username": "<user>", "password": "<pass>", "email": "<email address>", "full_name":"<name>"}' -H 'Content-Type: application/json' https://holiday-calendar.fi/api/register

Register user account

Request body

• username Callsign (allowed a-z, A-Z, 0-9 and '-')
• email Email Address (not shown to others)
• password Password
• full_name Real Name (not shown to others)

{ "username": "user", "email": "user@domain.com", "password": "pass", "full_name": "User Mcuserson" }

Result

No content, confirm email is sent

Register confirm

curl -d '"<confirmation code>"' -H 'Content-Type: application/json' https://holiday-calendar.fi/api/confirm

Activate account using confirm code

Request body

Confirmation code

"b480bb7f71c7a61a80d33bfcf42466bb"

Result

No content, you may now login

Users list

curl -G -H 'Authorization: Bearer <token>' https://holiday-calendar.fi/api/users

Lists all users

Parameters

None

Result

List of users with fields:

• username Callsign
• password always "***"
• email "***" for others, maybe null
• full_name "***" for others", maybe null

[
    {
        "username":"john-doe",
        "password": "***",
        "email":"john.doe@gmail.com",
        "full_name":"John Doe"
    },
    {
        "username":"test-dummy",
        "password": "***",
        "email":"***",
        "full_name":null
    }
]

My account

curl -H "Authorization: Bearer <token>" https://holiday-calender.fi/api/users/mine

Parameters

None

Result

Your user data

{"username":"john-doe", "email":"john.doe@testi123.com", "password": "***", "full_name":"John Doe"}

Forgot password

curl -H "Authorization: Bearer <token>" -H "Content-Type: application/json" -d '"<email>"' https://holiday-calender.fi/api/password/forgot

Send an email token to change password

Request body

Email address of the user for which to change password

"user@email.com"

Result

No content, email is sent to the user.

Forgot password confirm

curl -H "Content-Type: application/json" -d '{"token": "<emailed token>", "password": "<new password>"}' https://holiday-calender.fi/api/password/change

Change email using token from email

Request body

• token Emailed token
• password Password to set

{"token": "b480bb7f71c7a61a80d33bfcf42466bb", "password": "New password"}

Result

No content, password is updated on the user

Edit my Account

curl -XPUT -H "Authorization: Bearer <token>" -H 'Content-Type: application/json' -d '{"username": "<name>", "email": "<address>", "password": "<pass>", "full_name": "<name>"}' https://holiday-calendar.fi/api/users/mine

Request body

• username Callsign (allowed a-z, A-Z, 0-9 and '-')
• email Email Address (not shown to others)
• password Password
• full_name Real Name (not shown to others)

{"username": "user", "email": "user@domain.com", "password": "pass", "full_name": "User Mcuserson"}

Result

Updated user

{"username": "user", "email": "user@domain.com", "password": "pass", "full_name": "User Mcuserson"}

Delete my Account

curl -XDELETE -H "Authorization: Bearer <token>" https://holiday-calendar.fi/api/users/mine

Arguments

None

Result

Deleted user

{"username": "user", "email": "user@domain.com", "password": "pass", "full_name": "User Mcuserson"}

Create new schedule

curl -d '{"name": "<calendar name>", "participants": [<usernames>], "desc": "<description>"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer <token>' https://holiday-calendar.fi/api/schedule

Request body

• name Schedule name. Must be unique. Allowed characters numbers, letters and '-'.
• desc Schedule description
• participants list

{"name": "calendar","participants": ["john-doe"],"desc": "My first schedule"}

Result

Created schedule

{
"name": "calendar",
"owner": {
    "username":"john-doe",
    "email":"john.doe@gmail.com",
    "full_name":"John Doe"
},
"participants": [{
    "username":"john-doe",
    "email":"john.doe@gmail.com",
    "full_name":"John Doe"
}],
"desc": "My first schedule"}

List schedules

curl -H 'Authorization: Bearer <token>' https://holiday-calendar.fi/api/schedules

Result

List of schedules you have access to

[
    {
        "name": "calendar",
        "owner": {
            "username":"john-doe",
            "email":"john.doe@gmail.com",
            "full_name":"John Doe"
        }
        "participants": [{
            "username":"john-doe",
            "email":"john.doe@gmail.com",
            "full_name":"John Doe"
        }],
        "desc": "My first schedule"
    }
]

Get schedule info

curl -H 'Authorization: Bearer f098f17abd6d584a424e1b034fb93ba7' https://holiday-calendar.fi/api/schedule/<name>/info

Result

[
    {
        "name": "calendar",
        "owner": {
            "username":"john-doe",
            "email":"john.doe@gmail.com",
            "full_name":"John Doe"
        }
        "participants": [{
            "username":"john-doe",
            "email":"john.doe@gmail.com",
            "full_name":"John Doe"
        }],
        "desc": "My first schedule"
    }
]

Delete schedule

curl -XDELETE -H 'Authorization: Bearer <token>' https://holiday-calendar.fi/api/schedule/<name>

Result

Empty body

Change availability in schedule

curl -XPUT -H "Content-Type: application/json" -H "Authorization: Bearer <token>" -d '{<data>: <availability>, ...}' https://holiday-calendar.fi/api/schedule/<name>

Request body

availability indexed by data

• data YYYY-mm-dd
• availability
  • available
  • unavailable
  • not_set

{"2025-08-10": "available", "2025-08-11": "not_set", "2025-08-12": "unavailable"}

Result

Empty body

Get availabilities in Schedule

curl -H "Authorization: Bearer <token>" 'http://holiday-calendar.fi/api/schedule/<name>?start=<date>&end=<date>'

Parameters

• start Start date in form YYYY-mm-dd. Optional, default today.
• endEnd data in form YYYY-mm-dd. Optional default start date.

Result

A JSON object of lists of `availability` indexed by `date` and then `username`. `not_set` is filled in from holiday calendar.

• data YYYY-mm-dd
• availability
  • available
  • unavailable
  • not_set

{
    "2025-08-10": {
        "john-doe": "available",
        "jane-doe": "unavailable"
    },
    "2025-08-11": {
        "john-doe": "unavailable",
        "jane-doe": "unavailable"
    },
    "2025-08-12" {
        "john-doe": "unavailable",
        "jane-doe": "unavailable"
    }
}