Getting started

The Agent API configures and pilots 100% of Yoplanning the exact same way the web interface does. Every write is a bridge to the internal code the UI itself calls, so behaviour, validations and side effects are identical to the interface.

Base URL: https://yoplanning.pro/api/agent/v1/. Almost every resource lives under a team: /api/agent/v1/teams/{teamId}/<resource>.

Authenticate with a team-scoped token (Yoplanning settings → Advanced):

Authorization: Token 4804c2cb4d87a13146d4de029f407c82149f2ada

See the Overview page for the full contract (round-trip, references, translations, pagination, errors, permissions).

Read == Write

The JSON returned by a GET is exactly the JSON you send back on POST/PUT. To change something: GET → modify → PUT.

PUT /{id} is a true full replacement: send the entire object; any omitted field or sub-object is reset/removed for real (never a partial patch). Updating a non-existing id → 404 (no upsert).

References to other objects are always { "id": … }, identical on read and write; on write only id is used, the other fields are read-only echoes.