Skip to main content

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​

Organization management​

PromptResponse exampleNotes
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​

PromptResponse exampleNotes
I want to invite a new Customer to the platformMCP 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 344286Ask for a list of users to get the user ID.
Get details for Customer CustTest1

Advertiser management​

PromptResponse exampleNotes
Let's create a new Advertiser profileMCP 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​

The table below lists the tools that MCP uses in this tutorial, with links to their API documentation. For every Workspace API tool available in MCP, see the Workspace API section of the Tools index.

Tool nameDescriptionDocumentation
getAllowedOrganizationsGet a list of allowed organizationsGet list of allowed Organizations
getOrganizationProfileGet the organization's profile detailsGet Organization details
updateOrganizationProfileUpdate the organization's profileUpdate Organization profile
getInvitePreRequisiteGet pre-requisite details required before sending a customer invitationInvitation pre-requisite details
sendInvitationsInvite a customer to the platformInvite Customer to platform
getCustomersListGet a detailed list of customersGet Customer details
putCustomerOnHoldSuspend a customer accountPut Customer on-hold
assignCustomersToUserAssign customers to a userAssign Customer to user
getCustomerOperationDetailsByIdGet customer operations details by customer IDGet Customer operations details
addAdvertiserProfileAdd a new advertiser profileAdd Advertiser profile
updateAdvertiserProfileEdit an existing advertiser profileEdit Advertiser profile
getAdvertisersGet advertisers associated with a customerGet list of Advertisers for Customer
Have a question?
Was this page helpful?