Organisations, people and invitations
37 operations. Each page has its parameters, body, errors and examples.
- GET
/v1/me/organisationsOrganisations the person belongs to - GET
/v1/organisations/{id}An organisation, its people and invitations - PATCH
/v1/organisations/{id}Rename an organisation (owner) - GET
/v1/organisations/{id}/checklistWhat the organisation has set up and the next step, from real state - PUT
/v1/organisations/{id}/onboardingWhat the organisation wants to set up (owner or admin), or hide the checklist - GET
/v1/organisations/{id}/connectionsHow the organisation's products are connected to each other: every link, its state, who allowed it and what it allows - PUT
/v1/organisations/{id}/nudges/{nudge}Dismiss a suggestion to connect two products, for yourself - DEL
/v1/organisations/{id}/nudges/{nudge}Bring a dismissed suggestion back - PUT
/v1/organisations/{id}/also-products/{product}Add a product made by Rykon outside Rykloud (Swift Paybooks) to the organisation's home and menu, or hide it (owner or admin) - DEL
/v1/organisations/{id}/members/{memberId}Remove a person from the organisation - PATCH
/v1/organisations/{id}/members/{memberId}Change a person's role (admin, member, billing) - POST
/v1/organisations/{id}/invitationsInvite a person by address - DEL
/v1/organisations/{id}/invitations/{invitationId}Withdraw an invitation - GET
/v1/me/invitationsInvitations waiting for the person - POST
/v1/invitations/{id}/acceptAccept an invitation - POST
/v1/organisationsCreate an organisation; you are its owner - POST
/v1/organisations/{id}/leaveLeave the organisation (never its last owner) - POST
/v1/organisations/{id}/invitations/{invitationId}/resendSend an invitation again, with a new expiry - POST
/v1/organisations/{id}/transfersOffer ownership to a person in the organisation (owner); it changes when they accept - DEL
/v1/organisations/{id}/transfers/{transferId}Withdraw an ownership offer (owner) - GET
/v1/me/transfersOwnership offers waiting for the person - POST
/v1/transfers/{id}/acceptAccept an ownership offer - POST
/v1/transfers/{id}/declineDecline an ownership offer - GET
/v1/organisations/{id}/closureWhat deleting the organisation would do, and what stands in the way (owner) - POST
/v1/organisations/{id}/closureDelete the organisation after the grace period, confirmed by its name (owner) - DEL
/v1/organisations/{id}/closureCancel a deletion during the grace period (owner) - GET
/v1/me/closed-organisationsDeleted organisations the person owned (their audit record stays exportable) - GET
/v1/organisations/{id}/auditThe organisation's audit record, JSON pages or CSV (owners, and owners at the close) - POST
/v1/organisations/{id}/product-transfersOffer one of the organisation's product accounts to a confirmed address (owner) - GET
/v1/organisations/{id}/product-transfersThe organisation's product transfers, both directions (owners and admins) - GET
/v1/me/product-transfersProduct transfers offered to the person, and those they made - GET
/v1/product-transfers/{id}One product transfer (either side's owners and admins, the recipient) - POST
/v1/product-transfers/{id}/acceptAccept a product transfer into an organisation you own, or a new one - POST
/v1/product-transfers/{id}/declineDecline a product transfer offered to you - POST
/v1/product-transfers/{id}/withdrawWithdraw a product transfer before it moves (owner of the source) - GET
/v1/organisations/{id}/mail-grantsThe organisation's mail grants: Rykon AI's agent inboxes in Rykon Mail - DEL
/v1/organisations/{id}/mail-grants/{grantId}Revoke a mail grant (owner or admin); its inboxes are paused