How Do I Use the OpenAPI?

Our Open API add-on connects Vacation Tracker to your own tools. Create an API key, choose what it can do, and use it to read and change your data or get notified when something changes.

How to Create an API Key

1. Log in to your Vacation Tracker account at app.vacationtracker.io/signin.
2. Open Add-ons from the left menu.
3. On the My Add-ons tab, find Open API and click View. If it isn't there, find it on the Discover More Add-ons tab and activate it first.
4. In the API keys section, click Create API key.
5. Enter a Key name. Only people in your company see this name.
6. Optionally, enter an Integration name. People see it in Vacation Tracker next to every change the key makes, for example "Approved by Jane (through Payroll sync)". Leave it empty to show only the person's name.
7. Under Permissions, choose a template and adjust it if needed (see below).
8. Under Expiration, choose when the key expires: in 30 days, in 90 days, in 1 year (recommended), or never.
9. Check the Summary and click Create API key.
10. Copy the key and store it somewhere safe. The full key is shown only once, when it's created.

Choosing Permissions

Start with a template, then adjust:

• Read only: see data, change nothing. Good for reports and dashboards.
• Leave management: request, add, and approve leaves. Read users and leave types.
• Workspace setup: set up locations, departments, leave types, policies, holidays, and users.
• Custom: choose each permission yourself.

Each permission can be set to No access, Read, or Read & write. Approving and denying requests, seeing hidden leave type names, and acting on behalf of other users are separate checkboxes, so turn them on only if your tool needs them. A key can only do what you're allowed to do in Vacation Tracker.

Managing Your Keys

The API keys table lists every key in your workspace with its owner, permissions, last use, expiry date, and status. Click a key to open its details, where you can:

• See this month's usage and edit the key's name and permissions.
• Check Recent activity, which lists every request that changed data.
• Click Rotate key to get a new key with the same name and permissions. Choose whether the old key keeps working for 24 hours (recommended), for 7 days, or stops right away.
• Click Revoke to stop the key for good.

We email you 14 days before a key expires.

Making Your First Request

The base URL is https://api.vacationtracker.io/v2. Send your key as a bearer token in the Authorization header:

A successful call returns the data under data. Lists with more pages also include a nextToken, which you pass back to get the next page.

If something goes wrong, the response includes an error with a code, a description, and a resolution. A missing or unknown key returns 401. A key without the permission a request needs returns 403 with INSUFFICIENT_SCOPE.

How to Add a Webhook

1. On the Open API add-on page, go to Webhooks and click Manage webhooks.
2. Click Add webhook.
3. Enter the Endpoint URL that should receive the events. It must use HTTPS.
4. Under Events, choose Leave decisions, All time off activity, Keep a full copy in sync, or Custom to pick events yourself.
5. Click Add webhook.

You only get events for data you're allowed to see.

Quotas and Rate Limits

Limits apply per API key:

• Up to 30,000 requests per month.
• 10 requests per second, with a burst of up to 50 requests.

If your integration needs more, email developers@vacationtracker.io with your company name, the integration, and the traffic you expect.

Common Questions