access-requests

Invite someone outside the org to a restricted library

Manage-sharing gated. Creates an invitation carrying a pendingGrant that the accept path materializes; the invitee joins at orgRole (GUEST or MEMBER, the inviter's seat choice), becomes project VIEWER for project-scoped resources, and receives the grant. Restricted resources only (400 NOT_RESTRICTED); existing members are redirected to the grant picker (409 ALREADY_MEMBER); one live invite per email + resource (409 INVITE_PENDING); the member cap refuses at create (400 MEMBER_LIMIT). Same paths exist for /workspace/tables/{id} and /workspace/pages/{id}.

post/workspace/libraries/{id}/external-invites

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/workspace/libraries/{id}/external-invites
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

Library UUID

Headers

X-Organization-Idstring required

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

Request body

emailstring email required
accessLevel'VIEW' | 'CONTRIBUTE' | 'MANAGE' required
orgRole'GUEST' | 'MEMBER'

Response

{ id, email, orgRole, accessLevel, expiresAt }

Changes

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