Get started

Quick start

Three steps from nothing to your first rows of data. Only owners, admins and developers of the workspace can create keys.

Base address

/api/v1
  1. 1

    Create a key

    In Planifizer, open Developers → API and create a key. Name it after the system that will use it, then choose what it can read, its activities and when it expires.

    The key is shown once. Copy it into your system's secret settings straight away.
    Open API keys
  2. 2

    Check that it works

    Call /me with the key in the Authorization header. The answer says which workspace the key reads, what it can read and when it expires.

    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
      }
    }
  3. 3
Quick start — Planifizer API docs