Cloud API Reference
Use this page to find the Permit.io Cloud API reference and the facts every call needs: the base URL, the authentication header, and how API objects nest. It is for developers who call the Permit API directly or build on top of the OpenAPI spec.
Base URL and authentication
| Item | Value |
|---|---|
| Base URL | https://api.permit.io (all paths start with /v2) |
| EU region base URL | https://api.eu.permit.io, for workspaces hosted in the EU region |
| Authentication | Authorization: Bearer <YOUR_API_KEY> header on every request |
| Request and response format | JSON |
Get an API key from the Permit dashboard. See Get your API key. For curl, Postman, and SDK examples, see Calling the API.
Interactive API reference
The interactive API reference at https://api.permit.io/v2/redoc lists every endpoint with its parameters, request body, and response schema. The same reference is embedded below.
OpenAPI spec
The Permit Cloud API OpenAPI spec is available at https://api.permit.io/v2/openapi.json. Use the spec to generate a client or to import the API into a REST client such as Postman.
Permit API object hierarchy
Permit API objects nest in this order: a workspace (your organization) contains projects, and each project contains environments. Each environment holds its own API key, policy, tenants, roles, resources and actions, and users. A role assignment gives a user a role in a specific tenant.
Related pages
- Calling the API: API keys, rate limiting, regions, and curl and Postman examples
- PDP API reference: the API of the policy decision point (PDP)
- Background APIs: endpoints that run as background tasks