Spaces
During the onboarding process of a Banqup entity, a first space is created. Spaces are virtual environments (work spaces) where all relevant resources of an entity are managed. Spaces can also facilitate document exchange and communication among entities, depending on the space type. The role of spaces is to gather all relevant data of an entity into one accessible setting. Such data can include: invoices, connections, cards, clients, payments, users, installed apps etc. The capabilities offered by a space depends on the space type and the active subscription. Every space in Banqup has a unique identifier that is needed when performing certain API calls on that space.
📄️ Get extension clients
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve all extension clients of space <br/> Scope: space_read
📄️ Active client's extension
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Activate extension for client of a partner space <br/> Scope: space_write
📄️ Get extensions
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve all extensions of space <br/> Scope: space_read
📄️ Grant permission on extension
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Grant a permission (scope) on this extension to a user (requester) <br/> Scope: extension_write
📄️ Get extension client
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get extension client details <br/> Scope: space_read
📄️ Delete client extension
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete client extension with ID <br/> Scope: space_write
📄️ Get details
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve extension details <br/> Scope: space_read
📄️ Count extensions
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Count extensions by statuses <br/> Scope: space_read
📄️ Get settings
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve extension's settings <br/> Scope: space_read
📄️ Update settings
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update extension's settings via JSON patch <br/> Scope: extension_config
📄️ Mark for deletion
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Mark an extension for deletion. Will not have any effect if extension is already marked for deletion. <br/> Scope: extension_write
📄️ Update settings for the extension client
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update settings for the extension client via JSON patch <br/> Scope: extension_config
📄️ Update client extension's status
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update extension status for a client <br/> Scope: extension_config
📄️ Update extension status
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update extension's status <br/> Scope: extension_config
📄️ Assign roles to group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Assign roles to group <br/> Scope: space_write
📄️ Add users to group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Add users to group <br/> Scope: space_write
📄️ Get all groups
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of all (default & custom) groups for this space <br/> Scope: space_read
📄️ Create custom group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create new group of type CUSTOM in this space <br/> Scope: space_write
📄️ Get group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get default or custom group info on this space <br/> Scope: space_read
📄️ Delete custom group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Remove a custom group on this space <br/> Scope: space_write
📄️ Update custom group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update custom group info on this space <br/> Scope: space_write
📄️ List all roles of a group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> List all roles of a group for a space <br/> Scope: space_read
📄️ List all users of a group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> List all users of a group for a space <br/> Scope: space_read
📄️ Unassign roles from group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Unassign roles from group <br/> Scope: space_write
📄️ Unassign users from group
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Unassign users from group <br/> Scope: space_write
📄️ Get roles on space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of all roles for a space <br/> Scope: space_read
📄️ Create new custom role
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Create new role of type CUSTOM on space <br/> Scope: space_write
📄️ Get role details
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get role info on a space <br/> Scope: space_read
📄️ Delete custom role
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Remove custom role on a space <br/> Scope: space_write
📄️ Update custom role
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update custom role info on a space <br/> Scope: space_write
📄️ Update custom role's permissions
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update custom role's permissions. Permissions must be subset of space's permission tree <br/> Scope: space_write
📄️ Get the permission tree for a space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get the permissions tree a space <br/> Scope: space_write
📄️ Get partners
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve all partners of space <br/> Scope: space_read
📄️ Get space permissions
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve all permissions (granted/not granted) on this space <br/> Scope: space_read
📄️ Grant permission on space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Grant a permission (scope) on this space to a user (requester) <br/> Scope: space_write
📄️ Remove partner link
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Delete given space's partner link <br/> Scope: space_write
📄️ Get space details
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve data about this space, including some information of space's owning entity <br/> Scope: space_read
📄️ Update space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update space <br/> Scope: space_write
📄️ Revoke permission
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Revoke granted permission (scope) to user (requester) on this space <br/> Scope: space_write
📄️ Get current user's spaces
Retrieve all accessible spaces (on all accessible entities) for current user
📄️ Get current user's space context (deprecated)
Retrieve current user's context for this space (deprecated)
📄️ Get my permission tree
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get my permission tree <br/> Scope: space_read
📄️ Get space's context
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get space's context <br/> Scope: service_store
📄️ Get settings
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve space's settings <br/> Scope: space_read
📄️ Update space settings
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update space's settings using JSON patch <br/> Scope: space_write
📄️ Get the permission tree for a space subject
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get the permissions tree a space subject <br/> Scope: space_write
📄️ Overwrite the permission tree for a subject
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Overwrite the permission tree for a subject <br/> Scope: space_write
📄️ Get tax info
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve space's tax-related information <br/> Scope: space_read
📄️ Get current user's context for this space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Retrieve current user's context for this space <br/> Scope: space_read
📄️ Grant permission
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Grant a previously not granted permission (scope) on this space to a user (requester) <br/> Scope: space_write
📄️ Get all users on space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list of users on a space <br/> Scope: space_read
📄️ Add user to space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Add user to space <br/> Scope: space_write
📄️ Get user details
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get user details on a space <br/> Scope: space_read
📄️ Remove user from space
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Remove user from space <br/> Scope: space_write
📄️ Update user details
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Update user details <br/> Scope: space_write
📄️ Get all groups of a user
<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Get list groups of a user on a space <br/> Scope: space_read