PurrOSDocs
Endpoint reference

Platform

Discovery endpoints: enabled features, the calling key, the permission catalog and the OpenAPI document.

Call these first when an integration starts: GET /features tells it which features are switched on, so it can adapt, and GET /me confirms which key it is using.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

  • GET/features

    Features and whether they are enabled

    Keyany key
    Peopleanyone
  • GET/me

    The calling API key

    Keyany key
    Peopleanyone
  • GET/openapi.json

    OpenAPI document for enabled features

    Keypublic
    Peoplepublic
  • GET/permissions

    Permission catalog for enabled features

    Keyany key
    Peopleanyone

Users & Roles

Inviting and managing accounts, custom roles, and company sign-in settings.

Organization

Org units, locations and departments, plus read-only roles and users for integrations.