access-requests

Ask for access to a resource you cannot see

One open (PENDING) request per person + resource, deduped by a DB unique under concurrency (a duplicate answers 409 ALREADY_PENDING). Requires being an active member of the resource's org; the denial check is re-run server-side, the 403 payload is a hint, never the authority. 409 ALREADY_ACCESSIBLE when the caller can already open it; 400 OPEN_REQUEST_CAP at 10 open requests. Pending requests expire after 14 days. Deciders are notified (bell + email per their preference matrix).

post/access-requests

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/access-requests
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

resourceType'PROJECT' | 'PAGE' | 'LIBRARY' | 'TABLE' required
resourceIdstring required
notestring

Optional message the deciders will see.

Response

{ id, status: PENDING, createdAt }

Changes

No recorded changes to this operation across all 1 revision of this API.