Accounts API

Use the Accounts API to manage accounts, users, and related entities programmatically.

The Accounts API enables you to programmatically access and manage key account-related data within the Marketplace Platform.

It provides secure endpoints that allow you to perform operations such as creating, updating, and retrieving information about accounts, users, user groups, licensees, sellers, and API tokens.

Additionally, the API supports retrieving a list of available modules within the platform and managing ERP system links.

Before you start

Review the shared API docs before you work with account resources.

• Authentication

• URL structure

• Error handling

Core resources

The Accounts API is built around the following core resources:

• Account – Represents a client, vendor, or operations account.

• Account user – Represents an account user.

• API token – Represents an authentication token object.

• Buyer – Represents entities that engage in commercial activities and are the recipients of invoices issued by SoftwareOne.

• Cloud tenant – Represents a CloudTenant object in the Marketplace.

• ERP link – Represents a connection between the buyer object and the seller object in the Marketplace.

• Licensee – Represents entities that consume the software products or services procured by the buyer.

• Module – Represents modules available in the platform, for example, Marketplace.

• Seller – Represents SoftwareOne entities (for example, SoftwareOne Canada) that buy software solutions from vendors and sell those solutions to clients.

• User – Represents users who can sign in to the platform using their credentials and perform operations associated with their permissions.

• User group – Represents a UserGroup object in the Marketplace.

Browse collections

The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.

Use the following links to jump to the collection you need:

• Accounts

• Account Users

• API Tokens

• Buyers

• Cloud Tenants

• Sellers

• ERP Link

• Licensees

• Modules

• Users

• User Groups

Accounts

View Accounts operations

Operation	Method	Description	Access
Create account	POST	Creates a new account.	ops
Update account	PUT	Updates account details.	vendor, client, ops
Get account	GET	Retrieves a single Account by its ID.	vendor, client, ops
List accounts	GET	Retrieves the full Accounts collection.	vendor, client, ops
Enable account	POST	Re-enables a previously disabled account.	ops
Disable account	POST	Disables the account; users cannot log in.	ops
Activate account	POST	Activates an account that has been enabled.	ops
Validate account	POST	Validates account data before creation.	ops
Deactivate account	POST	Deactivates an active account.	ops
Get account icon	GET	Retrieves the account’s icon.	public

Account Users

View Account Users operations

Operation	Method	Description	Access
Create account user	POST	Invites or re‑invites a user to the account.	vendor, client, ops
List account users	GET	Lists all users assigned to the account.	vendor, client, ops
Get account user	GET	Retrieves an account user by ID.	vendor, client, ops
Delete account user	DELETE	Removes a user from the account.	vendor, client, ops
Accept user invitation	POST	Accepts a user invitation to the account.	vendor, client, ops
Assign user to groups	POST	Assigns an account user to specific groups.	vendor, client, ops
Resend user invitation	POST	Resends an invitation to the account.	vendor, client, ops
Send new invitation	POST	Sends a new invitation when the previous one expired.	vendor, client, ops
Update user group assignment	PUT	Updates a user’s group assignment.	vendor, client, ops
Remove user from group	DELETE	Removes an account user from specific groups.	vendor, client, ops

API Tokens

View API Tokens operations

Operation	Method	Description	Access
Create API token	POST	Creates an API token for the account.	vendor, client, ops
List API tokens	GET	Retrieves the API tokens collection.	vendor, client, ops
Get API token	GET	Retrieves an API token by ID.	vendor, client, ops
Update API token	PUT	Updates an existing API token.	vendor, client, ops
Delete API token	DELETE	Deletes an API token.	vendor, client, ops
Disable API token	POST	Disables an API token.	vendor, client, ops
Enable API token	POST	Enables a previously disabled API token.	vendor, client, ops

Buyers

View Buyers operations

Operation	Method	Description	Access
Create buyer	POST	Creates a buyer for the client account.	ops
List buyers	GET	Retrieves the buyers collection.	client, ops
Get buyer	GET	Retrieves a buyer by ID.	client, ops
Update buyer	PUT	Updates a buyer.	client, ops
Disable buyer	POST	Disables a buyer.	client, ops
Enable buyer	POST	Enables a previously disabled buyer.	ops
Validate buyer	POST	Validates buyer data.	ops
Delete buyer	DELETE	Deletes a buyer.	ops
Deactivate buyer	POST	Deactivates a buyer.	ops
Synchronize buyer	POST	Synchronizes a buyer with the ERP system.	ops
Transfer buyer	POST	Transfers a buyer and its dependencies between accounts with same External ID.	ops
Get buyer transfer details	GET	Retrieves buyer transfer information, optionally validating destination account.	public
Get buyer icon	GET	Retrieves the buyer’s icon.	vendor, client, ops

Cloud Tenants

View Cloud Tenants operations

Operation	Method	Description	Access
Create cloud tenant	POST	Creates a cloud tenant.	ops
List cloud tenants	GET	Retrieves the cloud tenants collection.	ops
Get cloud tenant	GET	Retrieves a cloud tenant by ID.	ops
Update cloud tenant	PUT	Updates a cloud tenant.	ops
Delete cloud tenant	DELETE	Deletes a cloud tenant.	ops

Sellers

View Sellers operations

Operation	Method	Description	Access
Create seller	POST	Creates a seller for the account.	ops
List sellers	GET	Retrieves the sellers collection.	client, ops
Get seller	GET	Retrieves a seller by ID.	client, ops
Update seller	PUT	Updates a seller.	ops
Activate seller	POST	Activates a previously deactivated or disabled seller.	ops
Deactivate seller	POST	Deactivates a seller.	ops
Disable seller	POST	Disables a seller.	ops
Delete seller	DELETE	Deletes a seller.	public
Get seller icon	GET	Retrieves the seller icon.	ops

ERP Link

View ERP Link operations

Operation	Method	Description	Access
List ERP links	GET	Retrieves the ERP Links collection.	client, ops
Get ERP link	GET	Retrieves an ERP Link by ID.	client, ops
Update ERP link	PUT	Updates an ERP Link.	ops
Unblock ERP link	POST	Unblocks an ERP Link.	ops
Block ERP link	POST	Blocks an ERP Link.	ops

Licensees

View Licensees operations

Operation	Method	Description	Access
Create licensee	POST	Creates a licensee linking a Buyer and Seller.	client, ops
List licensees	GET	Retrieves the licensees collection.	client, ops
Get licensee	GET	Retrieves a licensee by ID.	client, ops
Update licensee	PUT	Updates a licensee.	client, ops
Disable licensee	POST	Disables a licensee.	client, ops
Enable licensee	POST	Enables a previously disabled licensee.	client, ops
Delete licensee	DELETE	Deletes a licensee.	ops
Get licensee icon	GET	Retrieves the licensee icon.	public

Modules

View Modules operations

Operation	Method	Description	Access
List modules	GET	Retrieves the list of modules available in the portal.	ops

Users

View Users operations

Operation	Method	Description	Access
List users	GET	Retrieves the platform users collection.	vendor, client, ops
Get user	GET	Retrieves a user by ID.	vendor, client, ops
Get SSO configuration	GET	Retrieves SSO configuration for the user.	vendor, client, ops
Update user	PUT	Updates a user.	vendor, client, ops
Set user password	POST	Sets password for non‑SSO users during onboarding.	vendor, client, ops
Block user	POST	Blocks a user, preventing login.	ops
Unblock user	POST	Unblocks a previously blocked user.	ops

User Groups

View User Groups operations

Operation	Method	Description	Access
Create user group	POST	Creates a user group for the account.	vendor, client, ops
List user groups	GET	Retrieves the user groups collection.	vendor, client, ops
Get user group	GET	Retrieves a user group by ID.	vendor, client, ops
Update user group	PUT	Updates a user group.	vendor, client, ops
Delete user group	DELETE	Deletes a user group.	vendor, client, ops