MCP Workspace tutorial

Use IQM Model Context Protocol (MCP) to interact with the Workspace API.

Overview

This page provides examples of how to use IQM MCP to access and manage Workspaces with the Workspace API. The Workspace API is used to manage Organizations, Workspaces, Customers, and Advertisers:

• Organizations are top-level descriptions of a company's profile, including its name, website, and location details.
• Workspaces operate within Organizations and can be Customers or Advertisers.
• Users operate within Workspaces and can be assigned Customers.

Before you begin

To access Workspace API tools using IQM MCP, the following are required:

1. An account on the IQM platform
   • See Before you begin to create an account and request a Client ID and Client Secret
2. The user must have login access to the Organization and access to the Customer app to perform Customer-related actions

More resources

• Workspace API
• IQM platform overview
• Sign up a new Customer
• Organization management Help Center article

Organization management

Prompt	Response example	Notes
Show me a list of Organizations
Show me the logged-in Organization details
Let's update the Organization profile details. For description: "IQM Test Org 1" Website: "https://iqm.com/"		You can ask the MCP what details are available to update for an Organization and it gives you a list of fields that can be modified and the associated static lookup tools for certain entity IDs.

Customer management

Prompt	Response example	Notes
I want to invite a new Customer to the platform		MCP prompts the user for Customer details such as name, email, and Organization, and then sends an invitation to the specified email address.
Get me a list of Customers
Put Customer 205177 on hold
Assign Customer 205176 to user 344286		Ask for a list of users to get the user ID.
Get details for Customer CustTest1

Advertiser management

Prompt	Response example	Notes
Let's create a new Advertiser profile		MCP prompts the user to choose which Customer the Advertiser profile belongs to.
Let's update MCP Test Advertiser: Update the name to "New Advertiser 1" and the CEO name to "John Doe"
Show me a list of Advertisers for Customer SDK Test Customer

Tools index

In the tables below you can find the complete set of Workspace management tools available in the MCP, categorized by function.

Each tool includes a brief description and a link to the corresponding API documentation for more details on its functionality and usage.

Use this index as a reference to explore the various Workspace management capabilities of the MCP and how they relate to the Workspace API endpoints.

Organization details

Tool name	Description	Documentation
getAllowedOrganizations	Get a list of allowed organizations	Get list of allowed Organizations
getOrganizationProfile	Get the organization's profile details	Get Organization details
getUserInteractionEvents	Get a list of user interaction events	Get list of user interaction events
upsertInteractionEvent	Update or insert a user interaction event	Upsert interaction event
isDomainAvailable	Check if a workspace domain is available	Check for available domain
getOrganizationsApplications_1	Get the list of applications available for organizations	Organization applications list

Organization management

Tool name	Description	Documentation
updateOrganizationProfile	Update the organization's profile	Update Organization profile
updateOrganizationEmail	Update the organization's email address	Update Organization email

Whitelabel settings

Tool name	Description	Documentation
getWhiteLabelSettings	Get the organization's whitelabel settings	Get whitelabel settings
updateWhiteLabelSettings	Update whitelabel settings for the organization	Update whitelabel settings
addWhiteLabelDomain	Add a whitelabel domain to the organization	Add whitelabel domain
verifyWhiteLabelDomain	Verify the organization's whitelabel domain	Verify whitelabel domain
addWhiteLabelPixelUrl	Add a whitelabel pixel URL for the organization	Add whitelabel pixel URL

Workspace management

Tool name	Description	Documentation
createWorkspace	Create a new workspace	Create a Workspace
getAdminUserList	Get a list of admin users	Get list of admin users
updateWorkspaceDomain	Update a workspace domain	Update Workspace domain
getWorkspaces	Get a list of workspaces	Get list of Workspaces
getWorkspaceInitDetails	Get workspace initialization details	Get Workspace initialization details
getWorkspaceOrganizationLogo	Get the organization logo for a workspace	Get Workspace Organization logo
getWorkspaceChatBotAppIdByOwId	Get the chatbot app ID for a workspace by organization workspace ID	Get Workspace chatbot app ID
getWorkspaceChatBotAppIdByWorkspaceDomain	Get the chatbot app ID for a workspace by domain	Get Workspace chatbot app ID by domain
sendFindMyWorkspaceEmail	Send a "Find My Workspace" email to a user	Send find my Workspace email

Customer details

Tool name	Description	Documentation
getCustomersList	Get a detailed list of customers	Get Customer details
getCustomerBasicDetails	Get a basic details list for customers	Get basic Customer details
getMultiLevelOrganizations	Get a multi-level list of customers	Get multi-level Customers list
getImmediateCustomers	Get a list of immediate customers	Get immediate Customers list
getCustomerOperationDetailsById	Get customer operations details by customer ID	Get Customer operations details
getCustomerOperationLabels	Get the list of labels for customer operations	Get Customer operations label list
getCustomerCount	Get the count of customers grouped by status	Get count of Customers by status
getCustomersUsers	Get the users assigned to a specific customer	Get list of users for selected Customer
getUserAssignedCustomers	Get the customers assigned to a user	Get list of user assigned Customers
getRemainingCustomersForUser	Get the remaining customers available for assignment to a user	Get user's remaining Customers
getAllowedCustomersOWIds	Get the list of allowed customer organization workspace IDs	Get allowed Customer OW IDs
getRemainingApplication	Get the remaining applications available to assign to a customer	Get list of remaining apps for Customer
getMetabaseExternalServiceClientCredentials	Get Metabase external service client credentials	Get Metabase client credentials
getAdvertisers	Get advertisers associated with a customer	Get list of Advertisers for Customer

Customer management

Tool name	Description	Documentation
getInvitePreRequisite	Get pre-requisite details required before sending a customer invitation	Invitation pre-requisite details
sendInvitations	Invite a customer to the platform	Invite Customer to platform
resendCustomerInvitation	Resend a customer invitation	Resend Customer invite
cancelCustomerInvitation	Cancel a pending customer invitation	Cancel Customer invite
assignCustomersToUser	Assign customers to a user	Assign Customer to user
removeCustomersAssociationFromUser	Remove a customer association from a user	Unassign Customer from user
approveCustomer	Approve a customer sign-up request	Approve Customer
rejectCustomer	Reject a customer sign-up request	Reject Customer
addApplicationAccessToCustomer	Add application access for a customer	Add Customer app access
revokeApplicationAccessToCustomer	Revoke application access for a customer	Revoke Customer app access
putCustomerOnHold	Suspend a customer account	Put Customer on-hold
reactivateCustomer	Reactivate a suspended customer account	Re-activate Customer
addLabelForCustomerOperation	Add a label to a customer operation	Add label for Customer operation
updateIsBidShadingEnabledFlag	Enable or disable bid shading for a customer	Enable bid shading for Customer
updateCustomerOperationDetailsByOwId	Update customer operations details	Update Customer operations details

Advertiser management

Tool name	Description	Documentation
getAdvertiserProfiles	Get a list of advertiser profiles and details	Get list of Advertiser profile and details
addAdvertiserProfile	Add a new advertiser profile	Add Advertiser profile
updateAdvertiserProfile	Edit an existing advertiser profile	Edit Advertiser profile
deleteAdvertiserProfile	Delete an advertiser profile	Delete Advertiser profile

Static details lists

Tool name	Description	Documentation
getOrganizationWorkspaceStatus	Get the list of organization-workspace status options	Organization Workspace status
getUserOrganizationWorkspaceStatus	Get the list of user status options	User status
getCustomerType	Get the list of customer type options	Customer type
getCustomerPaymentType	Get the list of customer payment type options	Customer payment type
getCustomerAccountType	Get the list of customer account type options	Customer account type
getCustomerListSortableFields	Get the list of sortable fields for customer lists	Customer list sortable fields
getUserSortBy	Get the list of sort-by options for users	User sort by options
getOrganizationExpertize	Get the list of organization expertise options	Organization expertise
getCompanySize	Get the list of company size options	Company size
getIndustries	Get the list of industry options	Industries
getMediaBudget	Get the list of media budget options	Media budget
getVerticals	Get the list of available verticals	Verticals