Get started

API keys

Every request carries an API key. Owners, admins and developers create keys in Developers → API. A key can only read data.

Create a key

Creating a key takes two short steps:

  • Name · the system that will use it, for example WIP sync.
  • What it can read · schedules and hours are always included. Add planned vs actual or personal details only if the system needs them.
  • Activities · all of them, including the ones you add later, or only some.
  • Expiry · 30 days, 90 days, 6 months or 1 year.

Copy your key now

Planifizer only keeps a fingerprint of the key, so it can't show it again. If a key is lost, revoke it and create a new one.
Open API keys

What a key can read

AccessWhat it covers
Schedules and hoursAlways includedPublished plannings: shifts, breaks, time off and hours. Every key has it.
Planned vs actualThe live day as it happened: late starts, missed and added shifts.
Personal detailsNames, emails and phone numbers of agents and supervisors. Leave it off when codes are enough.

Send it with every request

Send your key in the Authorization header of every request.

Authorization: Bearer pfz_live_••••••••••••••••••••x9Rf

Keys start with pfz_live_. Keep them on your servers: never in a browser, a mobile app, a code repository or an email. A key sent in the URL is refused.

Check a key

To check that a key works, call /me.

curl "/api/v1/me" \
  -H "Authorization: Bearer $PLANIFIZER_API_KEY"
{
  "workspace": {
    "id": "0f6e1b8a-…",
    "name": "Your workspace"
  },
  "key": {
    "name": "WIP sync",
    "last_four": "x9Rf",
    "scopes": [
      "reports:read"
    ],
    "created_at": "2026-10-12T09:00:00.000Z",
    "expires_at": "2027-01-10T09:00:00.000Z"
  },
  "activities": [
    {
      "code": "AC-0006",
      "name": "Caraïbes"
    }
  ],
  "rate_limit": {
    "per_minute": 60,
    "remaining": 59
  }
}

A key stops working when

  • it reaches its expiry date
  • an owner, admin or developer revokes it
  • the person who created it is no longer an owner, admin or developer

To replace a key without a gap, create the new one first, switch your system over, then revoke the old one.

API keys — Planifizer API docs