{ "opencollection": "1.0.0", "info": { "name": "One-Shot access invites API", "version": "1.0.0" }, "items": [ { "info": { "name": "invites", "type": "folder" }, "items": [ { "info": { "name": "Get Workspace Invite By Token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/invites/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resolve an invite token to its workspace_id. Used by the router to detect already-accepted invites." }, { "info": { "name": "List Workspace Invites", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspace_id/invites", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List pending (not accepted, not expired) invites for a workspace." }, { "info": { "name": "Create Workspace Invite", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaces/:workspace_id/invites", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a magic-link invite for a workspace. Returns the token." }, { "info": { "name": "Update Workspace Invite", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/workspaces/:workspace_id/invites/:invite_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "invite_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the role and/or message of a pending invite in place." }, { "info": { "name": "Revoke Workspace Invite", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workspaces/:workspace_id/invites/:invite_id", "params": [ { "name": "workspace_id", "value": "", "type": "path" }, { "name": "invite_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Revoke (delete) a pending invite. Owners and editors may revoke any invite." }, { "info": { "name": "Get My Pending Workspace Invite", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspace_id/my-pending-invite", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return the authenticated user's pending invite for a workspace, identified by email match." }, { "info": { "name": "Accept My Pending Workspace Invite", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaces/:workspace_id/my-pending-invite/accept", "params": [ { "name": "workspace_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Accept the authenticated user's pending invite for a workspace, identified by email match." }, { "info": { "name": "Accept Workspace Invite", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/invites/:token/accept", "params": [ { "name": "token", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Accept a magic-link invite. Adds the authenticated user as a workspace member." } ] } ], "bundled": true }