Migrate a Workspace

Overview

The API Comparison table highlights the shared actions and API methods between IQM and Beeswax for creating and managing Workspaces, Customers, and Advertisers. Select an endpoint to review each platform's relevant API documentation. By comparing APIs, you can migrate your workflow from Beeswax to IQM.

For a comprehensive overview of IQM's finance services, see the Workspace API.

Definitions

IQM	Beeswax	Description
Organization	Account	The entity containing an Organization's or company's details (address, email, website, etc.).
Workspace (User)	User	A user that signs up with the platform and receives authentication credentials: Organization Workspace ID (owId) for IQM; Account ID for Beeswax. Workspace Users are also referred to as Advertisers or Customers in different contexts.
Advertiser (Customer)	Advertiser	Once an Advertiser is assigned to a Workspace User, they become a Customer (they also operate as their own Workspaces). An Advertiser can be assigned to one Workspace; and they can have multiple Insertion Orders assigned to them.

API Comparison

Base URLs

  IQM: https://app.iqm.com
  
  Beeswax: https://{buzz_key}.api.beeswax.com

Action	IQM Endpoint	Beeswax Endpoint	Notes
Create an Organization	n/a	POST/rest/v2/accounts	For IQM, Organization details are created on Customer invite/assignment.
Get Organization Details	GET/api/v3/ua/organization/view-profile GET/api/v3/ua/user/allowed-organizations	GET/rest/v2/accounts GET/rest/v2/accounts/{id}
Create a Workspace (User)	POST/api/v3/ua/workspace POST/api/v3/ua/user/invite POST/api/v3/ua/sign-up	POST/rest/v2/users
Get Workspace (User) Details	GET/api/v3/ua/customers/workspaces/list GET/api/v3/ua/users/list	GET/rest/v2/users GET/rest/v2/users/{id}
Add Advertiser Profile	POST/api/v3/ua/organization/advertiser/add POST/api/v3/ua/customer/invite POST/api/v3//ua/user/customer/assign	POST/rest/v2/advertisers	For IQM, an Advertiser is created when inviting a Customer to signup, and then assigning them to a User.
Get Advertiser Details	GET/api/v3/ua/organization/advertisers/list GET/api/v3/ua/customers/list	GET/rest/v2/advertisers GET/rest/v2/advertisers/{id}
User Permissions	POST/api/v3/ua/user/application/add POST/api/v3/ua/customer/application/add	POST/rest/v2/roles	For Beeswax permissions are defined in the /roles endpoint with the permissions object. A role_id is then added on user creation.

More Workspace Resources

IQM:

• User Management API
• Workspace API
• IQM Platform Overview
• Sign Up and Authenticate (Quickstart Guide)
• Manage your Organization (Help Center Article)

Beeswax:

• Accounts, Users, Roles, Permissions