Workspace API

This page covers the common methods and endpoints for managing 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.

More resources

• IQM platform overview
• Organization management Help Center article

Authentication

Use the following header parameters for all requests:

Headers
Authentication string required	Authentication bearer token. See Sign up and authenticate.
X-IAA-OW-ID integer required	Organization Workspace ID header.

Organization details

An Organization is any company that places ads. An Organization is created on Customer invite, with details including its name, website, and location details. This section covers the methods and endpoints for getting Organization lists and details.

Organization resource properties

Properties
owId integer	Organization Workspace ID.
organizationName string	Organization name.
email string	Organization email.
ownerUserEmail string	Owner user email.
workspaceDomain string	Workspace domain.
customerType string	Customer type. +Supported values 1 Self served 2 Managed services 3 App users 4 Advertisers 5 Workspaces
logoUrl string	Logo URL.
dateOfJoining string	Date of joining IQM platform.
title string	Title.
website string	Organization website.
contactNumber string	Organization phone number.
address string	Organization address.
city string	Organization city location.
state integer	State ID of Organization location.
country integer	Country ID of Organization location.
zipcode string	Zipcode.
isAvatarUrl boolean	Indicates whether Organization has uploaded a logo. If true, a default avatar logo is generated when one hasn't been uploaded.
organizationLogo string	Logo image file.
industry string	Industry ID.
companySize integer	Company size ID. +Supported values 1 1-10 2 11-50 3 51-200 4 201-500 5 501-1000 6 1001-5000 7 5000+
companyId string	Company ID.
taxId string	Tax ID.
currency string	Currency type.
dateFormat string	Date format, e.g. "MM/DD/YYYY".
description string	Description of Organization.
verticalId integer	Vertical ID. +Supported values 1 Political 2 Healthcare 3 Specialty
expertize string	Comma separated expertise IDs. +Supported values 1 Account administration 2 Campaign optimization 3 Creative services 4 Audience building 5 Inventory management 6 Finance & accounting 7 Campaign creation
isAvailable boolean	Indicates that a Workspace domain is available: true.

---

Get list of allowed Organizations

GET

Get a list of allowed Organizations by Customer type.

Query parameters
customerAccountType string	Comma separated Customer type IDs. +Supported values 1 Self served 2 Managed services 3 App users 4 Advertisers 5 Workspaces
searchField string	Filter results by search field.
limit integer	Number of entries returned per page, default: 10.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-), default: lastActive. Supported values: organizationName, title, dateOfJoining, lastActive.

JSON

Response 200

{
  "success": true,
  "data": {
    "data": [
      {
        "owId": 200001,
        "organizationName": "Super IQM Org",
        "ownerUserEmail": "pratik.t+ihp@iqm.com",
        "workspaceDomain": "app.stage.inhousebuying.com",
        "customerType": "Workspace",
        "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/ihb_logo_scaled.png",
        "dateOfJoining": null,
        "title": null
      },
      {
        "owId": 200002,
        "organizationName": "IQM Corporation",
        "ownerUserEmail": "kartik.g@iqm.com",
        "workspaceDomain": "iqm.stage.inhousebuying.com",
        "customerType": "Workspace",
        "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png",
        "dateOfJoining": "2021-09-28",
        "title": null
      }
    ],
    "totalRecords": 2,
    "filteredRecords": 2
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            owId: number;
            organizationName: string;
            ownerUserEmail: string;
            workspaceDomain: string;
            customerType: string;
            logoUrl: string;
            dateOfJoining: string | null;
            title: string | null;
          }[];
          totalRecords: number;
          filteredRecords: number;
        };
      };
    };
  };
  422: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        errorObjects: {
          error: string;
        }[];
      };
    };
  };
};

function GetallowedOrganizationsList(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/user/allowed-organizations',
    params: {
      query: {
        customerType: `string`,
        searchField: `string`,
        pageNo: `number`,
        limit: `number`,
        sortBy: `string`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Organization details

GET

Get the profile information of an Organization for the logged-in Organization.

JSON

Response 200

{
  "success": true,
  "data": {
    "organizationName": "JP test org1",
    "email": "jinesh.p+jptest1@iqm.com",
    "website": "www.jptest1.com",
    "contactNumber": "+91 123987456",
    "address": "A-123, ABC complex",
    "city": "Ahmedabad",
    "state": 1672,
    "country": 113,
    "zipcode": "382418",
    "isAvatarUrl": false,
    "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/391.png",
    "industry": "Advertising",
    "companySize": 2,
    "companyId": "A-123456",
    "taxId": "JP123456",
    "currency": "Dollar ($)",
    "dateFormat": "DD/MM/YYYY",
    "description": "",
    "verticalId": 1,
    "expertize": "1,2,3"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          organizationName: string;
          email: string;
          website: string;
          contactNumber: string;
          address: string;
          city: string;
          state: number;
          country: number;
          zipcode: string;
          isAvatarUrl: boolean;
          organizationLogo: string;
          industry: string;
          companySize: number;
          companyId: string;
          taxId: string;
          currency: string;
          dateFormat: string;
          description: string;
          verticalId: number;
          expertize: string;
        }
      }
    };
  };
};

function getOrganizationProfile(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/organization/view-profile',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of user interaction events

GET

Retrieve the list of user interaction events available.

Query parameters
userInteractionEvent string	Filter by interaction event name; use comma-separated values for multiple events.

Response properties

userInteractionEvent string	Interaction event identifier.
eventCount integer	Number of times the event has occurred.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "userInteractionEvent": "advertiser_user_login",
      "eventCount": 5
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          userInteractionEvent: string;
          eventCount: number;
        }[];
      };
    };
  };
}

function GetUserInteractionEvents(params?: {
  userInteractionEvent?: string;
}): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/interaction/events',
    params,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Upsert interaction event

PUT

Update or insert a user interaction event for the logged-in user.

Request schema
userInteractionEvent string required	Unique interaction event identifier.
metaData object	Key-value metadata to associate with the event.

Response properties

message string

Confirmation message.

JSON

Request sample

{
  "userInteractionEvent": "advertiser_user_login",
  "metaData": {
    "isOwnerUser": true
  }
}

Response 200

{
  "success": true,
  "data": {
    "message": "User interaction event persisted successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          message: string;
        };
      };
    };
  };
}

function UpsertInteractionEvent(requestBody: {
  userInteractionEvent: string;
  metaData?: Record<string, unknown>;
}): Promise<Responses> {
  const options = {
    method: 'PUT',
    url: 'https://api.iqm.com/api/v3/ua/interaction/event',
    data: requestBody,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Check for available domain

GET

Check if a Workspace domain is available.

Query parameters
workspaceSubDomain string	Name of domain to check.

JSON

Response 200

{
    "success": true,
    "data": {
        "isAvailable": true
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
  } from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          isAvailable: boolean;
        };
      };
    };
  };
}

function GetavailableDomain(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/organization/available-domain',
    parms: {
      query: {
        workspaceSubDomain: `string`
      }
    },
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Organization applications list

GET

Retrieve a list of applications available for Organizations, filtered by whether the Organization is an Advertiser or Workspace.

Query parameters
isAdvertiser boolean	Filter applications for Advertiser Organizations (default: false).
isWorkspace boolean	Filter applications for Workspace Organizations (default: false).

Response properties

appId integer	Application ID.
appName string	Application name.
appIcon string	Application icon URL.
appUrl string	Application URL.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "appId": 1,
      "appName": "IQM Platform",
      "appIcon": "https://example.com/icon.png",
      "appUrl": "https://app.iqm.com"
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          appId: number;
          appName: string;
          appIcon: string;
          appUrl: string;
        }[];
      };
    };
  };
}

function GetOrganizationApplicationsList(params?: {
  isAdvertiser?: boolean;
  isWorkspace?: boolean;
}): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/organizations/applications/list',
    params,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Organization management

Update Organization profile

PATCH

Update Organization profile details.

Refer to the Organization resource properties for schema. Include any properties to update in the request body.

Response properties

success boolean	Indicates report was successfully created: true.
data object	Updated organization details.
message string	Success message.

JSON

Request sample

{
  "organizationName": "New Org Name",
  "email": "neworgemail@org.com",
  "website": "neworgwebsite.com"
}

Response 200

{
  "success": true,
  "data": {
    "organizationId": 12345,
    "organizationName": "Updated Org Name",
    "organizationLogo": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/organization-profile/391/1633180356403.png",
    "message": "Profile updated successfully."
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          organizationLogo: string;
          message: string;
        };
      };
    };
  };
};

function UpdateOrganizationprofile(): Promise < Responses > {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/organization/update-profile',
    requestBody?: {
      content: {
        "application/x-www-form-urlencoded": {
          organizationName: `string`,
          email: `string`,
          website: `string`,
          contactNumber: `string`,
          address: `string`,
          city: `string`,
          state: `number`,
          country: `number`,
          zipcode: `number`,
          industry: `string`,
          companySize: `number`,
          companyId: `string`,
          taxId: `string`,
          currency: `string`,
          dateFormat: `string`,
          expertize: `string`,
          description: `string`,
          organizationLogo: `string`,
          removeOrganizationLogo: `boolean`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Organization email

PATCH

Update the primary email address for an Organization.

Request schema
email string	Email to update.

Response properties

success boolean	Indicates report was successfully created: true.
email string	Updated email address.
message string	Success message.

JSON

Request sample

{
  "email": "example.gmail.com"
}

Response 200

{
  "success": true,
  "data": {
    "email": "example.gmail.com",
    "message": "Organization email updated successfully."
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
  } from "prerequisites"
const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          email: string;
          message: string;
        };
      };
    };
  };
}

function Add/Updateorganizationsupportemail(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/organization/update-email',
    requestBody: {
      content: {
        "application/json": {
          email: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Whitelabel settings

Manage custom branding for your Organization's whitelabel configuration, including domain settings, favicon, and pixel tracking URLs.

Get whitelabel settings

GET

Retrieve the current whitelabel branding settings for the Organization.

Response properties

isIncludeOrganizationName boolean	Include the Organization name in branding: true.
smallFavIconUrl string	URL of the small favicon image.
largeFavIconUrl string	URL of the large favicon image.
landingPageUrl string	URL of the whitelabel landing page.
headerUrls array of objects	List of header URL objects.
headerUrls object properties url string Header URL.
footerUrls array of objects	List of footer URL objects.
footerUrls object properties url string Footer URL.

JSON

Response 200

{
  "success": true,
  "data": {
    "isIncludeOrganizationName": true,
    "smallFavIconUrl": "https://icon-url.com/favicon-small.ico",
    "largeFavIconUrl": "https://icon-url.com/favicon-large.ico",
    "landingPageUrl": "https://landing-page.com/page.html",
    "headerUrls": [{ "url": "http://example.com" }],
    "footerUrls": [{ "url": "http://example.com" }]
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          isIncludeOrganizationName: boolean;
          smallFavIconUrl: string;
          largeFavIconUrl: string;
          landingPageUrl: string;
          headerUrls: { url: string }[];
          footerUrls: { url: string }[];
        };
      };
    };
  };
}

function GetWhitelabelSettings(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/organization/whitelabel-settings',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update whitelabel settings

PATCH

Update whitelabel branding settings. Accepts multipart/form-data for file uploads.

Form fields
isIncludeOrganizationName boolean	Include the Organization name in branding: true.
smallFavIcon binary	Small favicon image file.
largeFavIcon binary	Large favicon image file.
landingPage binary	Landing page file.
headerUrls string	JSON array string of header URL objects.
footerUrls string	JSON array string of footer URL objects.
removeSmallFavIcon string	Flag to remove the existing small favicon.
removeLargeFavIcon string	Flag to remove the existing large favicon.
removeLandingPage string	Flag to remove the existing landing page.

Response properties

data string

Success message.

JSON

Response 200

{
  "success": true,
  "data": "White label settings updated successfully"
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function UpdateWhitelabelSettings(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/organization/whitelabel-settings',
    headers: { 'Content-Type': 'multipart/form-data' },
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Add whitelabel domain

POST

Configure a custom whitelabel domain for the Organization.

Request schema
whitelabelDomain string required	Custom domain to configure for whitelabeling.
verificationToken string optional	DNS verification token.

Response properties

data string

Success message.

JSON

Request sample

{
  "whitelabelDomain": "brand.example.com"
}

Response 200

{
  "success": true,
  "data": "White label domain configured successfully"
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function AddWhitelabelDomain(requestBody: {
  whitelabelDomain: string;
  verificationToken?: string;
}): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/organization/whitelabel-domain',
    data: requestBody,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Verify whitelabel domain

GET

Verify the DNS configuration for the Organization's whitelabel domain.

Response properties

verified boolean	Indicates the domain DNS configuration has been verified: true.
domain string	The whitelabel domain that was verified.
message string	Message describing the verification result.

JSON

Response 200

{
  "success": true,
  "data": {
    "verified": true,
    "domain": "brand.example.com",
    "message": "Domain verified successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          verified: boolean;
          domain: string;
          message: string;
        };
      };
    };
  };
}

function VerifyWhitelabelDomain(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/organization/verify-whitelabel-domain',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Add whitelabel pixel URL

POST

Add a whitelabel pixel URL for tracking or integration purposes.

Request schema
whitelabelPixelUrl string required	pixel URL to associate with the Organization's whitelabel configuration.

Response properties

data string

Success message.

JSON

Request sample

{
  "whitelabelPixelUrl": "example.pixel.com"
}

Response 200

{
  "success": true,
  "data": "Whitelabel pixel URL added successfully"
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function AddWhitelabelPixelUrl(requestBody: {
  whitelabelPixelUrl: string;
}): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/organization/whitelabel-pixel-url',
    data: requestBody,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Workspace management

A Workspace provides DSP service to another company, meaning it can have 'child' Workspaces known as Customers (see Get multi-level Customers list). This section covers the methods and endpoints for managing Workspace details.

Create a Workspace

POST

Create a Workspace by providing an invitation hash, Workspace domain, and creator details.

Request schema
domain string	Domain name of Workspace.
creatorEmail string	Creator email.
inviteHash string	Invite Hash.

Response properties

success boolean	Indicates Workspace was successfully created: true.
message string	Success message.

JSON

Request sample

{
    "domain": "app",
    "creatorEmail": "kartik.g@iqm.com",
    "inviteHash": "37KgCLieN6s/JxRgqYqeIV0UiAp3OWHdTjPUq8tVEilibQ9Bpo6ky+ZZeg8Wf3L9A0a3uBboKrijwXq0YZ0Qq3WXImlKQOgjYyZ7w5J6SPVwkvHTwe8yyHI2MIyR11URBlgOwoGnLtV8G4Cab+K4orlNjTnxLN+KFsYALpv0JDQkhvjRVxO8CJKhHahxu3rXZ3w6154n7PKTMZJs1ZR3r73dwHd8Ug0c/q7xB1ilGWIFnVVDb1gt1k8S5gYRNsxo9vESo0n8otr5/ha0SgW/qCZjxypIvO/59FXbjQ=="
}

Response 200

{
    "success": true,
    "message": "Workspace created successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        message: string;
      };
    };
  };
}

function CreateWorkspace(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/workspace',
    requestBody: {
      content: {
        "application/json": {
          domain: `string`,
          creatorEmail: `string`,
          inviteHash: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of admin users

GET

Retrieve a paginated list of admin users, filterable by status and searchable by name or ID.

Query parameters
searchField string	Search by user name or user ID.
noOfEntries integer	Results per page (default: 20).
pageNo integer	Page number (default: 1).
sortBy string	Sort field and direction: prefix + for ascending, - for descending. Allowed: userId, userName (default: +userId).
userStatusIds string	Comma-separated user status IDs. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Deleted

Response properties

totalRecords integer	Total number of admin user records.
filteredRecords integer	Number of records matching the applied filters.
adminUsersList array of objects	List of admin users.
adminUsersList object properties userName string Display name of the admin user. userId integer Unique identifier of the admin user.

JSON

Response 200

{
  "success": true,
  "data": {
    "totalRecords": 598,
    "filteredRecords": 255,
    "adminUsersList": [
      { "userName": "user-1", "userId": 1 },
      { "userName": "user-2", "userId": 2 }
    ]
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          totalRecords: number;
          filteredRecords: number;
          adminUsersList: {
            userName: string;
            userId: number;
          }[];
        };
      };
    };
  };
}

function GetAdminUserList(params?: {
  searchField?: string;
  noOfEntries?: number;
  pageNo?: number;
  sortBy?: string;
  userStatusIds?: string;
}): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/admin-users/list',
    params,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Workspace domain

PATCH

Update a Workspace domain.

Request schema
workspaceSubDomain string	New Workspace domain name.

Response properties

success boolean	Indicates report was successfully created: true.
message string	Success message.

JSON

Request sample

{
    "workspaceSubDomain": "jptest"
}

Response 200

{
    "success": true,
    "data": "Workspace domain update successfully."
}

More responses

Response 422

{
    "success": false,
    "errorObjects": [
        {
            "error": "A Workspace with this URL already exists, please try a different one"
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
  422: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        errorObjects: {
          error: string;
        }[];
      };
    };
  };
}

function Updateworkspacedomain(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/organization/workspace-domain',
    requestBody: {
      content: {
        "application/json": {
          workspaceSubDomain: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Validate Workspace domain

POST

Validate if a Workspace domain is available and if the user email is associated with the Workspace.

Request schema
email string	Email.
workspaceDomain string	Workspace domain name.

Response properties

success boolean	Indicates if the Workspace domain validation was successful: true.
isValid boolean	Indicates if the Workspace domain is valid: true.
message string	Validation message.

JSON

Request sample

{
    "email": "user@ihp.com",
    "workspaceDomain": "app.stage.inhousebuying.com"
}

Response 200

{
    "success": true,
    "data": {
        "isValid": true,
        "message": "Workspace is valid"
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          isValid: boolean;
          message: string;
        };
      };
    };
  };
  403: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        errorObjects: {
          error: string;
        }[];
      };
    };
  };
}

function Validateworkspacedomain(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/user/workspace/validate',
    requestBody: {
      content: {
        "application/json": {
          email: `string`,
          workspaceDomain: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of Workspaces

GET

Get a list of Workspaces associated with the logged-in user (i.e. Customers). Results can be filtered by search field.

Query parameters
searchField string	Filter results by search field.

Response properties

owId integer	Organization Workspace ID.
workspaceName string	Workspace name.
logoUrl string	Logo URL.
statusId string	Status ID.
status string	Status.
ownerUserName string	Owner user name.
ownerUserEmail string	Owner user email.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "owId": 202373,
            "workspaceName": "Workspace 1",
            "logoUrl": "https://iqm-web-assets/avatar/WS.png",
            "statusId": 1,
            "status": "Active",
            "ownerUserName": "Workspace User 1",
            "ownerUserEmail": "workspaceUser1@iqm.com"
        },
        {
            "owId": 200002,
            "workspaceName": "Workspace 2",
            "logoUrl": "https://iqm-web-assets/avatar/IC.png",
            "statusId": 1,
            "status": "Active",
            "ownerUserName": "Workspace User 2",
            "ownerUserEmail": "WorkspaceUser2@iqm.com"
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        data: {
          owId: number;
          workspaceName: string;
          logoUrl: string;
          statusId: number;
          status: string;
          ownerUserName: string;
          ownerUserEmail: string;
        }[];
      };
    };
  };
}

function getWorkspaces(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/workspaces/list',
    params: {
      query: {
        searchField?: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Workspace initialization details

GET

Retrieve initialization details for the Workspace, including configuration, settings, and metadata.

Response properties

workspaceId integer	Workspace ID.
workspaceName string	Workspace name.
organizationName string	Organization name.
domain string	Workspace domain.
isActive boolean	Indicates the Workspace is active: true.
features array of strings	List of enabled features for the Workspace.
configuration object	Workspace configuration settings.
configuration object properties theme string UI theme (e.g., light, dark). language string Language code (e.g., en).

JSON

Response 200

{
  "success": true,
  "data": {
    "workspaceId": 1,
    "workspaceName": "My Workspace",
    "organizationName": "My Organization",
    "domain": "my-workspace.example.com",
    "isActive": true,
    "features": ["feature1", "feature2"],
    "configuration": { "theme": "light", "language": "en" }
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          workspaceId: number;
          workspaceName: string;
          organizationName: string;
          domain: string;
          isActive: boolean;
          features: string[];
          configuration: { theme: string; language: string };
        };
      };
    };
  };
}

function GetWorkspaceInitDetails(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/init',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Workspace Organization logo

GET

Retrieve the logo for the Workspace Organization. Returns a redirect (HTTP 308) to the logo URL.

---

Get Workspace chatbot app ID

GET

Retrieve the chatbot application ID for the Workspace based on the user's Organization type and role.

Response properties

chatbotAppId string

Chatbot application ID; empty string if not configured.

JSON

Response 200

{
  "success": true,
  "data": {
    "chatbotAppId": "p7yzll40"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: { chatbotAppId: string };
      };
    };
  };
}

function GetWorkspaceChatBotAppIdByOwId(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/chatbot',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Workspace chatbot app ID by domain

GET

Retrieve the chatbot application ID configured for a Workspace identified by domain.

Response properties

chatbotAppId string

Chatbot app ID; empty string if not configured.

JSON

Response 200

{
  "success": true,
  "data": {
    "chatbotAppId": "p7yzll40"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: { chatbotAppId: string };
      };
    };
  };
}

function GetWorkspaceChatBotAppIdByWorkspaceDomain(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/st/chatbot',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Send find my Workspace email

POST

Send an email listing the Workspace domain(s) associated with the given email address, for users who've forgotten which Workspace they belong to. No authentication is required.

info

This endpoint is rate limited to 100 requests per minute, per IP. Exceeding it returns a 429 (Too Many Requests) error. See Rate limits.

Request schema
email string required	User's email address.

Response properties

message string

Generic confirmation message, always the same regardless of whether the email matches a Workspace.

JSON

Request sample

{
  "email": "user@example.com"
}

Response 200

{
  "success": true,
  "data": {
    "message": "If an account exists for this email address, an email has been sent."
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          message: string;
        };
      };
    };
  };
}

function SendFindMyWorkspaceEmail(requestBody: {
  email: string;
}): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/find-my-workspace',
    data: requestBody,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Customer details

A Customer is an Advertiser or Workspace in a financial agreement with another Workspace. For any given Workspace, an Advertiser is a Customer. This section covers the methods and endpoints for getting lists and details of Customers.

Customer resource properties

Resource properties
isUserAllowed boolean	Specifies if the Organization is permitted to log in for the currently logged-in user: true.
isWorkspaceOwner boolean	Specifies if the Organization owns the Workspace; meaning, the org owner and the current org are the same: true.
owId integer	Organization Workspace ID.
organizationName string	Organization name.
isAccess boolean	Indicates logged-in user has Customer management access of given Customer Organization: true.
workspaceName string	Workspace name.
workspaceDomain string	Workspace domain.
owStatus string	Organization Workspace status type. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Rejected
owStatusId integer	OW status type ID. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Rejected
createdAt string	Creation timestamp.
modifiedAt string	Modification timestamp.
parentOrganizationName string	Parent Organization name.
tags array of strings	Customer type tags. +Supported values 1 Self served 2 Managed services 3 App users 4 Advertisers 5 Workspaces
customersCount integer	Customer count.
balance integer	Budget balance.
contactPersonName string	Name of contact.
contactPersonEmail string	Email of contact.
approvedBy string	Name of who approved Customer.
approvedByEmail string	Email of who approved Customer.
logoUrl string	Logo URL.
activeCampaignsCount integer	Number of active campaigns associated with Customer.
runningCampaigns integer	Number of campaigns with "running" status associated with Customer.
industry integer	Industry type ID.
companySize integer	Company size ID. +Supported values 1 1-10 2 11-50 3 51-200 4 201-500 5 501-1000 6 1001-5000 7 5000+
mediaBudget integer	Media budget ID. +Supported values 1 < $50,000 2 $50,000 - $100,000 3 $100,000 - $500,000 4 $500,000 - $1,000,000 5 $1,000,000 - $10,000,000 6 > $10,000,000
budgetSpent integer	Budget spent.
showFinance boolean	Show financial information: true.
workspaceId integer	Workspace ID.
wsId integer	The Workspace ID under which a Customer owID belongs.
lastAccess integer	Records the last time the org was accessed.
verticalTypeId integer	Vertical type ID. +Supported values 1 Political 2 Healthcare 3 Specialty
onHoldReason string	Description of reason why Customer is in 'on-hold' status.

---

Customer operations resource properties

Resource properties
email string	Customer email.
name string	Customer name.
password string	Customer password.
onwerUserName string	Customer owner.
verticalId integer	Vertical type ID. +Supported values 1 Political 2 Healthcare 3 Specialty
logoUrl string	Logo URL.
customerOperationDetails object	Customer operations details (Workspace only).
customerOperationDetails object properties customerTypeId integer Customer type ID. +Supported values 1 Self served 2 Managed services 3 App users 4 Advertisers 5 Workspaces customerPaymentTypeId integer Customer payment type ID. +Supported values 1 PrePaid 2 PostPaid countryId integer Country ID. adOpsAssigneeUserIds array of integers User IDs assigned by the IQM AdOps team. sellerAssigneeUserIds array of integers User IDs assigned by the client/seller team. labelIds array of integers Label ID.
overridenFields object	Object containing the same fields as customerOperationDetails where true indicates a super user has overridden that field.
resetFields object	Object containing the same fields as customerOperationDetails where true indicates a super user has reset that field.
operationalLabels object	Operational labels details.
operationalLabels object properties label string Label name. id integer Label ID.

---

Get Customer details

GET

Get a list of Customers and their details.

Query parameters
owIds string	Comma separated Organization Workspace IDs whose Customers need to be retrieved. If owId of Advertiser is passed, endpoint will return Advertiser details. If owId of Workspace is passed, endpoint will return Workspace and its Advertisers details.
childOwIds string	Comma separated OW IDs of Organizations which will only be provided in response (to filter second level Customers only).
status string	Comma separated owId status IDs. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Rejected
customerType string	Comma separated Customer type IDs. +Supported values 1 Self served 2 Managed services 3 App users 4 Advertisers 5 Workspaces
searchField string	Filter results by search field.
limit integer	Number of entries returned per page, default: 10.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-), default: -runningCampaigns.
customerAccountType string	Customer account type ID. +Supported values 1 Advertiser 2 Workspace

JSON

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "isUserAllowed": false,
                "isWorkspaceOwner": false,
                "owId": 100404,
                "organizationName": "AdAgencyABC 1",
                "workspaceName": "AdAgencyABC 1",
                "workspaceDomain": "yourworkspace1.iqm.com",
                "owStatus": "active",
                "owStatusId": 1,
                "createdAt": "2021-10-01T22:20:46.000+00:00",
                "modifiedAt": "2021-10-01T22:20:46.000+00:00",
                "parentOrganizationName": "AdAgencyABC 1",
                "tags": [
                    "Self Service",
                    "Advertiser"
                ],
                "customersCount": 0,
                "balance": 1000000,
                "contactPersonName": "yourname 1",
                "contactPersonEmail": "yourname@yourcompany1.com",
                "approvedBy": "yourname 3",
                "approvedByEmail": "yourname@yourcompany3.com",
                "logoUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/TA.svg",
                "activeCampaignsCount": 28,
                "industry": 1,
                "companySize": 2,
                "mediaBudget": 3,
                "budgetSpent": 1000,
                "showFinance": false,
                "workspaceId": 632,
                "lastAccess": 0,
                "verticalTypeId": 1,
                "onHoldReason": null
            },
            {
                "isUserAllowed": false,
                "isWorkspaceOwner": false,
                "owId": 100431,
                "organizationName": "AdAgencyABC 2",
                "workspaceName": "AdAgencyABC 1",
                "workspaceDomain": "yourworkspace1.iqm.com",
                "owStatus": "active",
                "owStatusId": 1,
                "createdAt": "2021-10-01T22:20:46.000+00:00",
                "modifiedAt": "2021-10-01T22:20:46.000+00:00",
                "parentOrganizationName": "AdAgencyABC 1",
                "tags": [
                    "Self Service",
                    "Advertiser"
                ],
                "customersCount": 0,
                "balance": 0,
                "contactPersonName": "yourname 2",
                "contactPersonEmail": "yourname@yourcompany2.com",
                "approvedBy": "yourname 3",
                "approvedByEmail": "yourname@yourcompany3.com",
                "logoUrl": "https://iqm-web-assets-c92d6b6cbde1-stage.s3.amazonaws.com/avatar/IQ.svg",
                "activeCampaignsCount": 23,
                "industry": 1,
                "companySize": 2,
                "mediaBudget": 3,
                "budgetSpent": 1000,
                "showFinance": false,
                "workspaceId": 632,
                "lastAccess": 0,
                "verticalTypeId": null,
                "onHoldReason": null
            }
        ],
        "totalRecords": 2,
        "filteredRecords": 2
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        data: {
          data: {
            isUserAllowed: boolean;
            isWorkspaceUser: boolean;
            owId: number;
            organizationName: string;
            workspaceName: string;
            workspaceDomain: string;
            owStatus: string;
            owStatusId: number;
            createdAt: string;
            modifiedAt: string;
            parentOrganizationName: string;
            tags: string[];
            customerscount: number;
            balance: number;
            contactPersonName: string;
            contactPersonEmail: string;
            approvedBy: string;
            approvedEmail: string;
            logoUrl: string;
            activeCampaignsCount: number;
            industry: number;
            companySize: number;
            mediaBudget: number;
            budgetSpent: number;
            showFinance: boolean;
            workspaceId: number;
            lastAccess: number;
            verticalTypeId: number;
            onHoldReason: string;
          }[];
          totalRecords: number;
          filteredRecords: number;
        }
      };
    };
  };
}

function getCustomersList(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/workspaces/list',
    params: {
      query: {
        owIds?: `string`,
        childOWIds?: `string`,
        status?: `string`,
        customerType?: `string`,
        customerAccountType?: `string`,
        countryId?: `number`,
        verticalId?: `number`,
        adOpsAssigneeUserIds?: `string`,
        sellerAssigneeUserIds?: `string`,
        labelIds?: `string`,
        customerPaymentTypeIds?: `string`,
        searchField?: `string`,
        limit?: `number`,
        pageNo?: `number`,
        sortBy?: `string`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get basic Customer details

POST

Request schema
searchField string	Filter results by search field.
noOfEntries integer	Number of entries returned per page, default: 20.
pageNo integer	Page number of retrieved data, default: 1.
owIds array of integers	Organization Workspace IDs.
owStatusIds array of integers	Organization Workspace status type ID. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Rejected
provideRunningCampaigns boolean	Get running campaign count (true), default: false.

JSON

Request sample

{
    "owStatusIds": [
        1,
        2
    ],
    "pageNo": 1,
    "noOfEntries": 20,
    "owIds": [
        20001
    ],
    "searchField": "Agency",
    "provideRunningCampaigns": false
}

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "owId": 20001,
                "organizationName": "AdAgencyABC 1",
                "organizationLogo": "https://logo-bucket/avatar/123456.png",
                "owStatus": "Active",
                "owStatusId": 1,
                "wsId": 2,
                "runningCampaigns": 0,
                "ownerUserName": "yourname 1",
                "ownerUserEmail": "yourname@yourcompany1.com"
            }
        ],
        "totalRecords": 2,
        "filteredRecords": 1
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        data: {
          data: {
            owId: number;
            organizationName: string;
            organizationLogo: string;
            owStatus: string;
            owStatusId: number;
            wsId: number;
            runningCampaigns: number;
            ownerUserName: string;
            ownerUserEmail: string;
          }[];
          totalRecords: number;
          filteredRecords: number;
        }
      };
    };
  };
}

function getCustomerBasicDetails(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/basic/list',
    requestBody: {
      content: {
        "application/json": {
          searchBy?: `array of strings`,
          owIds?: `array of numbers`,
          owStatusIds?: `array of numbers`,
          ids?: `array of numbers`,
          provideRunningCampaigns?: `boolean`,
          pagination?: `string`,
          pageNo?: `number`,
          noOfEntries?: `number`,
          sortBy?: `string`,
          searchField?: `string`,
          order?: `string`,
          offset?: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get multi-level Customers list

GET

Query parameters
owIds string	Comma separated OW IDs of Organizations whose Customers need to be retrieved.
status string	Organization Workspace status ID. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Rejected
searchField string	Filter results by search field.
limit integer	Number of entries returned per page, default: 10.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-), default: +superParentOrganizationId.

JSON

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "owId": 200129,
                "organizationName": "AdAgencyABC 1",
                "isAccess": true,
                "logoUrl": "https://logo-bucket/avatar/123456.png",
                "status": "Active",
                "statusId": 1,
                "activeCampaignsCount": 17,
                "ownerUserName": "yourname 1",
                "ownerUserEmail": "yourname@yourcompany1.com",
                "customers": [
                    {
                        "owId": 200176,
                        "organizationName": "AdAgencyABC 4",
                        "logoUrl": "https://logo-bucket/avatar/123456.png",
                        "status": "Active",
                        "statusId": 1,
                        "activeCampaignsCount": 0,
                        "ownerUserName": "yourname 4",
                        "ownerUserEmail": "yourname@yourcompany4.com"
                    },
                    {
                        "owId": 200177,
                        "organizationName": "AdAgencyABC 5",
                        "logoUrl": "https://logo-bucket/avatar/123456.png",
                        "status": "Active",
                        "statusId": 1,
                        "activeCampaignsCount": 0,
                        "ownerUserName": "yourname 5",
                        "ownerUserEmail": "yourname@yourcompany5.com"
                    }
                ]
            },
            {
                "owId": 200422,
                "organizationName": "AdAgencyABC 2",
                "isAccess": false,
                "logoUrl": "https://logo-bucket/avatar/123456.png",
                "status": "Active",
                "statusId": 1,
                "activeCampaignsCount": 0,
                "ownerUserName": "yourname 2",
                "ownerUserEmail": "jp@iqm.com",
                "customers": [
                    {
                        "owId": 200425,
                        "organizationName": "AdAgencyABC 6",
                        "logoUrl": "https://logo-bucket/avatar/123456.png",
                        "status": "Active",
                        "statusId": 1,
                        "activeCampaignsCount": 17,
                        "ownerUserName": "yourname 6",
                        "ownerUserEmail": "yourname@yourcompany6.com"
                    },
                    {
                        "owId": 200495,
                        "organizationName": "AdAgencyABC 7",
                        "logoUrl": "https://logo-bucket/avatar/123456.png",
                        "status": "Active",
                        "statusId": 1,
                        "activeCampaignsCount": 17,
                        "ownerUserName": "yourname 7",
                        "ownerUserEmail": "yourname@yourcompany7.com"
                    }
                ]
            },
            {
                "owId": 200424,
                "organizationName": "AdAgencyABC 3",
                "isAccess": true,
                "customers": [],
                "logoUrl": "https://logo-bucket/avatar/123456.png",
                "status": "Active",
                "statusId": 1,
                "activeCampaignsCount": 17,
                "ownerUserName": "yourname 3",
                "ownerUserEmail": "yourname@yourcompany3.com"
            }
        ],
        "totalRecords": 3,
        "filteredRecords": 3
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        data: {
          data: {
            owId: number;
            organizationName: string;
            isAccess: boolean;
            logoUrl: string;
            status: string;
            statusId: number;
            activeCampaignsCount: number;
            ownerUserName: string;
            ownerUserEmail: string;
            customers: {
              owId: number;
              organizationName: string;
              logoUrl: string;
              status: string;
              statusId: number;
              activeCampaignsCount: number;
              ownerUserName: string;
              ownerUserEmail: string;
            }[];
          }[];
          totalRecords: number;
          filteredRecords: number;
        }
      };
    };
  };
}

function getMultiLevelOrganizations(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/list/multi-level',
    params: {
      query?: {
        owIds?: `string`,
        searchField?: `string`,
        sortBy?: `string`,
        status?: `string`,
        limit?: `number`,
        pageNo?: `number`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get immediate Customers list

GET

Get only immediate Customers of provided OW IDs (if owId is not provided then the OW ID in the header will be passed).

Query parameters
owIds string	Comma separated Organization Workspace IDs whose immediate Customers need to be retrieved.
childOwIds string	Comma separated OW IDs of Organizations which will only be provided in response (to filter second level Customers only).
status string	Comma separated Organization Workspace status IDs. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Rejected
customerType string	Comma separated Customer type IDs. +Supported values 1 Self served 2 Managed services 3 App users 4 Advertisers 5 Workspaces
searchField string	Filter results by search field.
limit integer	Number of entries returned per page, default: 10.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-), default:

JSON

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "isUserAllowed": false,
                "owId": 500,
                "organizationName": "Walmart Non IHB 1",
                "workspaceName": "walmart1.stage.inhousebuying.com",
                "workspaceDomain": "walmart1.stage.inhousebuying.com",
                "owStatus": "Active",
                "createdAt": "2021-09-05T22:55:10.000+00:00",
                "parentOrganizationName": "Walmart 1",
                "tags": [
                    "Self Service",
                    "Advertiser"
                ],
                "customersCount": 0,
                "balance": 0,
                "contactPersonName": null,
                "contactPersonEmail": "kartik.g+wni1@iqm.com",
                "approvedBy": "Walmart 1",
                "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png",
                "activeCampaignsCount": 0
            }
        ],
        "totalRecords": 1,
        "filteredRecords": 1
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        data: {
          data: {
            isUserAllowed: boolean;
            owId: number;
            organizationName: string;
            workspaceName: string;
            workspaceDomain: string;
            owStatus: string;
            createdAt: string;
            parentOrganizationName: string;
            tags: string[];
            customersCount: number;
            balance: number;
            contactPersonName: string;
            contactPersonEmail: string;
            approvedBy: string;
            logoUrl: string;
            activeCampaignsCount: number;
          }[];
          totalRecords: number;
          filteredRecords: number;
        }
      };
    };
  };
}

function getImmediateCustomers(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/immediate/customers/list',
    params: {
      query?: {
        owIds?: `string`,
        childOwIds?: `string`,
        searchField?: `string`,
        sortBy?: `string`,
        status?: `string`,
        limit?: `number`,
        pageNo?: `number`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Customer operations details

GET

Path parameters
owId integer	Organization Workspace ID.

JSON

Response 200

{
    "success": true,
    "data": {
        "workspaceCustomerOperationDetails": {
            "customerTypeId": 1,
            "owId": 202879,
            "customerPaymentTypeId": 2,
            "countryId": 30100001,
            "adOpsAssigneeUserIds": [
                7184
            ],
            "sellerAssigneeUserIds": [
                6900
            ],
            "labelIds": [
                1,
                3,
                4
            ],
            "overridenFields": {
                "customerTypeId": false,
                "customerPaymentTypeId": false,
                "countryId": false,
                "adOpsAssigneeUserIds": false,
                "sellerAssigneeUserIds": false,
                "labelIds": false
            }
        }
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          workspaceCustomerOperationDetails: {
            customerTypeId: number;
            owId: number;
            customerPaymentTypeId: number;
            countryId: number;
            adOpsAssigneeUserIds: number[];
            sellerAssigneeUserIds: number[];
            labelIds: number[];
            overridenFields: {
              customerTypeId: boolean;
              customerPaymentTypeId: boolean;
              countryId: boolean;
              adOpsAssigneeUserIds: boolean;
              sellerAssigneeUserIds: boolean;
              labelIds: boolean;
            }
          }
        }
      };
    };
  };
}

function getCustomerOperationDetailsById(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customer-operations/details/{owId}',
    params: {
      path: {
        owId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Customer operations label list

GET

Get a list of labels for Customer operations.

Query parameters
searchField string	Filter results by search field.
noOfEntries integer	Number of entries returned per page, default: 20.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-), default: -id. Supported values: id, name, startTime, endTime, totalBudget.

JSON

Response 200

{
    "success": true,
    "data": {
        "totalRecords": 36,
        "filteredRecords": 36,
        "operationalLabels": [
            {
                "label": "Test Label with 30 chars - 857",
                "id": 29
            },
            {
                "label": "Test Label with 30 characters.",
                "id": 16
            }
        ]
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          totalRecords: number;
          filteredRecords: number;
          operationLabels: {
            label: string;
            id: number
          }[]
        }
      };
    };
  };
}

function getCustomerOperationLabels(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customer-operations/label/list',
    params: {
      query?: {
        searchField?: `string`,
        noOfEntries?: `number`,
        pageNo?: `number`,
        sortBy?: `string`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get count of Customers by status

GET

Get a count of Customers by status and OW ID.

Query parameters
owIds string	Filter results by comma separated OW IDs.

Response properties

name string	Status name.
id integer	Status ID. +Supported values 1 Active 2 Pending 3 Invited 4 Suspended 5 Rejected
label string	Status label.
order integer	Order.
statusCount integer	Customer count.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "name": "pending",
            "id": 2,
            "label": "Pending",
            "order": 1,
            "statusCount": 0
        },
        {
            "name": "active",
            "id": 1,
            "label": "Active",
            "order": 2,
            "statusCount": 1900
        },
        {
            "name": "invited",
            "id": 3,
            "label": "Invited",
            "order": 3,
            "statusCount": 0
        },
        {
            "name": "suspended",
            "id": 4,
            "label": "Suspended",
            "order": 4,
            "statusCount": 87
        },
        {
            "name": "rejected",
            "id": 5,
            "label": "Rejected",
            "order": 5,
            "statusCount": 0
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
          statusCount: number
        }[]
      };
    };
  };
}

function getCustomerCount(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/count',
    params: {
      query?: {
        owIds: `array of numbers`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of users for selected Customer

GET

Get a list of users for the given Customer (Organization).

Query parameters
owId string	OW ID of Customer for which user list will be retrieved.
limit integer	Number of entries returned per page, default: 10.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-), default: -displayName.

Response properties

userID integer	User ID.
displayName string	User display name.
userAvatar string	User avatar.
email string	User email.
userTitle string	User title.
orgId integer	Organization ID.
organizationName string	Organization name.
apps object	Apps details.
apps object properties appId integer Bundle ID for app request. appName string App name. appIcon string App icon.

JSON

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "userId": 1,
                "displayName": "IHP",
                "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png",
                "email": "pratik.t+ihp@iqm.com",
                "userTitle": "CEO",
                "orgId": 1,
                "organizationName": "IHP",
                "apps": [
                    {
                        "appId": 1,
                        "appName": "Customers",
                        "appIcon": null
                    },
                    {
                        "appId": 2,
                        "appName": "Dashboard",
                        "appIcon": null
                    }
                ]
            }
        ],
        "totalRecords": 1,
        "filteredRecords": 1
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {

            userId: number;
            displayName: string;
            userAvatar: string;
            email: string;
            userTitle: string;

            orgId: number;
            organizationName: string;
            apps: {

              appId: number;
              appName: string;
              appIcon: string | null;
            }[];
          }[];

          totalRecords: number;

          filteredRecords: number;
        };
      };
    };
  };
}

function GetUserslistforselectedcustomer(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/users/list',
    params: {
      query?: {
        owId: `number`,
        pageNo: `number`,
        limit: `number`,
        sortBy: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of user assigned Customers

GET

Query parameters
uowId string	Customers assigned to user Organization Workspace ID.
limit integer	Number of entries returned per page, default: 2.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-). Supported values: createdAt, organizationName.

JSON

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "owId": 58,
                "organizationName": "Amul",
                "createdAt": 1629361572000,
                "contactPersonName": "Amul",
                "contactPersonEmail": "pratik.t+nonihp@iqm.com"
            },
            {
                "owId": 169,
                "organizationName": "Volkswagen India",
                "createdAt": 1629346722000,
                "contactPersonName": "Volkswagen India",
                "contactPersonEmail": "shraddha.p+vw@iqm.com"
            }
        ],
        "totalRecords": 3,
        "filteredRecords": 2
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            owId: number;
            organizationName: string;
            createdAt: number;
            contactPersonName: string;
            contactPersonEmail: string;
          }[];
          totalRecords: number;
          filteredRecords: number;
        };
      };
    };
  };
}

function UserassignedCustomers(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/user/assigned-customers',
    params: {
      query?: {
        uowId: `number`,
        pageNo: `number`,
        limit: `number`,
        sortBy: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get user's remaining Customers

GET

Query parameters
uowId string	Customers assigned to user Organization Workspace ID.
owIds string	Organization Workspace IDs.
limit integer	Number of entries returned per page, default: 2.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-). Supported values: contactPersonName, organizationName.

JSON

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "owId": 169,
                "organizationName": "Volkswagen India",
                "createdAt": 1629346722000,
                "balance": 0,
                "contactPersonName": "Volkswagen India",
                "contactPersonEmail": "shraddha.p+vw@iqm.com",
                "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png",
                "activeCampaignsCount": 0
            },
            {
                "owId": 170,
                "organizationName": "Coca-Cola",
                "createdAt": 1629346703000,
                "balance": 0,
                "contactPersonName": "Coca-Cola",
                "contactPersonEmail": "shraddha.p+cc@iqm.com",
                "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/logo/iqm.png",
                "activeCampaignsCount": 0
            }
        ],
        "totalRecords": 2,
        "filteredRecords": 2
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            owId: number;
            organizationName: string;
            createdAt: number;
            balance: number;
            contactPersonName: string;
            contactPersonEmail: string;
            logoUrl: string;
            activeCampaignsCount: number;
          }[];
          totalRecords: number;
          filteredRecords: number;
        };
      };
    };
  };
}

function User'sremainingCustomers(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/user/remaining-customers',
    params: {
      query?: {
        owIds: `string`,
        pageNo: `number`,
        limit: `number`,
        sortBy: `string`
        searchField: `string`,
        uowId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of Customer's allowed applications

GET

Get a list of a Customer's allowed applications along with the allowed user's list.

Query parameters
owId string	OW ID of Customer for which application list will be retrieved.
limit integer	Number of entries returned per page, default: 10.
pageNo integer	Page number of retrieved data, default: 1.
sortBy string	Sorts by ascending (+) or descending (-), default: -appName.

Response properties

appId integer	Bundle ID for app request.
appName string	App name.
appOwner string	App owner.
appIcon string	App icon.
appType string	App type.
subscriptionPrice integer	Subscription price.
users object	User details.
users object properties firstName integer First name. lastName string Last name. email string Email. displayName string Display name. userAvatar string User avatar.

JSON

Response 200

{
    "success": true,
    "data": {
        "data": [
            {
                "appId": 2,
                "appName": "Dashboard",
                "appOwner": "IHB",
                "appIcon": null,
                "appType": "Default App",
                "subscriptionPrice": 0,
                "users": [
                    {
                        "firstName": "Shraddha",
                        "lastName": "Patel",
                        "email": "shraddha.p+emailtest1@iqm.com",
                        "displayName": "Shraddha Patel",
                        "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg"
                    },
                    {
                        "firstName": "Shraddha",
                        "lastName": "P",
                        "email": "shraddha.p+emailtest2@iqm.com",
                        "displayName": "Shraddha P",
                        "userAvatar": "https://tmpd3vsekqsh1zre3k8n-stage.s3.amazonaws.com/avatar/SP.svg"
                    }
                ]
            },
            {
                "appId": 1,
                "appName": "Customers",
                "appOwner": "IHB",
                "appIcon": null,
                "appType": "Default App",
                "subscriptionPrice": 0,
                "users": [
                    {
                        "firstName": "Kartik",
                        "lastName": "Gevariya",
                        "email": "kartik.g@iqm.com",
                        "displayName": "Kartik Gevariya",
                        "userAvatar": "https://s3.amazonaws.com/admp0ed7fer7ert0em3rip5dy2/1/15e544b7b11040c1b56a61d2ab8450b4.png"
                    },
                    {
                        "firstName": "SP-IQM-User",
                        "lastName": null,
                        "email": "shraddha.p+iqmuser@iqm.com",
                        "displayName": "SP-IQM-User",
                        "userAvatar": null
                    }
                ]
            }
        ],
        "totalRecords": 10,
        "filteredRecords": 10
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            appId: number;
            appName: string;
            appOwner: string;
            appIcon: string | null;
            appType: string;
            subscriptionPrice: number;
            users: {
              firstName: string;
              lastName: string | null;
              email: string;
              displayName: string;
              userAvatar: string | null;
            }[];
          }[];
          totalRecords: number;
          filteredRecords: number;
        };
      };
    };
  };
}

function GetCustomerAllowedApplications(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/applications/list',
    params: {
      query?: {
        owId: `number`,
        pageNo: `number`,
        limit: `number`,
        sortBy: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get allowed Customer OW IDs

GET

Retrieve the list of Organization Workspace IDs that the logged-in user has access to.

Response properties

data array of integers

List of Organization Workspace IDs the logged-in user has access to.

JSON

Response 200

{
  "success": true,
  "data": [200002, 200003, 200004, 200005]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: number[];
      };
    };
  };
}

function GetAllowedCustomersOWIds(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/allowed-customers-ids',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of remaining apps for Customer

GET

Query parameters
owId string	OW ID of Customer for which application list will be retrieved.

Response properties

appId integer	Bundle ID for app request.
appName string	App name.
appIcon string	App icon.
orgName string	Organization name.
appType string	App type.
userCount integer	User count.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "appId": 6,
            "appName": "Accounts",
            "appIcon": "",
            "orgName": "IHP",
            "appType": "Default App",
            "userCount": 0
        },
        {
            "appId": 8,
            "appName": "Audiences",
            "appIcon": "",
            "orgName": "IQM Corporation",
            "appType": "Default App",
            "userCount": 0
        }
        ...
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          appId: number;
          appName: string;
          appIcon: string | null;
          orgName: string;
          appType: string;
          userCount: number;
        }[];
      };
    };
  };
}

function GetremainingApplicationlistforCustomer(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/remaining-applications/list',
    params: {
      query?: {
        owId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get remaining applications for user

GET

Retrieve the list of applications that can still be assigned to a user.

Query parameters
uowId integer required	User Organization Workspace ID.

Response properties

applicationId integer	Application ID.
applicationName string	Application name.
applicationCode string	Application code.

JSON

Response 200

{
  "success": true,
  "data": [
    { "applicationId": 1, "applicationName": "Google Ads", "applicationCode": "GA" },
    { "applicationId": 2, "applicationName": "Facebook Ads", "applicationCode": "FB" }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          applicationId: number;
          applicationName: string;
          applicationCode: string;
        }[];
      };
    };
  };
}

function GetRemainingApplications(params: {
  uowId: number;
}): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/user/remaining-applications',
    params,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Metabase client credentials

POST

Retrieve the Metabase embed URL for dashboard visualization. Restricted to allowed users of super Workspace with Campaign Insight app access.

Query parameters
dashboardType string required	Dashboard type (e.g., demographic, geographic).

Response properties

embedUrl string	Metabase embed URL for the dashboard.
dashboardType string	Dashboard type identifier.
expiresAt string	Expiration timestamp in ISO 8601 format.

JSON

Response 200

{
  "success": true,
  "data": {
    "embedUrl": "https://metabase.example.com/embed/dashboard/...",
    "dashboardType": "demographic",
    "expiresAt": "2026-05-06T15:30:00Z"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          embedUrl: string;
          dashboardType: string;
          expiresAt: string;
        };
      };
    };
  };
}

function GetMetabaseClientCredentials(params: {
  dashboardType: string;
}): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/ext/metabase-details',
    params,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get list of Advertisers for Customer

GET

Get a list of Advertisers for a given Customer.

Query parameters
owId string	OW ID of Customer for which Advertiser list will be retrieved.

Response properties

id integer	Advertiser ID.
advertiserName string	Advertiser name.
website string	Advertiser website.
chiefName string	Advertiser chief name.
contactNumber string	Advertiser contact phone number.
contactAddress string	Advertiser contact address.

JSON

Response 200

{
    "success": true,
    "data": [
        {
        "id": 1,
        "advertiserName": "Nikon",
        "website": "http://nikonindia.com",
        "chiefName": "Nil Miles",
        "contactNumber": "+91 9999999999",
        "contactAddress": null
        },
        {
        "id": 2,
        "advertiserName": "Nike",
        "website": "http://nikeindia.com",
        "chiefName": "Nike",
        "contactNumber": "+91 9999988888",
        "contactAddress": null
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          advertiserName: string;
          website: string;
          chiefName: string;
          contactNumber: string;
          contactAddress: string | null;
        }[];
      };
    };
  };
}

function GetAdvertiserslistforCustomer(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customers/advertisers/list',
    params: {
      query?: {
        owId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Customer config details

GET

Get Customer configuration details for an Advertiser or Workspace.

Path parameters
customerOwId integer	Customer Organization Workspace ID.

Response properties

organizationType string	Type of Organization: Advertiser or Workspace.
pldMarkupValue integer	Provider Level Data (PLD) markup value (for Workspace only).
pldRateForDiscount integer	PLD rate for discount.
pldMarkupTypeId integer	PLD markup type ID (for Workspace only).
pldMarkupPercentageForDiscount integer	PLD markup percentage for discount.
slsRateForDiscount integer	ScriptLift Studies (SLS) rate for discount (for Advertiser only).
slsMarkupPercentageForDiscount integer	SLS markup percentage for discount (for Advertiser only).
pgCampaignFees integer	Programmatic guaranteed campaign fees.
vertical string	Customer vertical (for Advertiser only).
isBidShadingEnabled boolean	Indicates bid shading is enabled: true.
isPldEnabled boolean	Indicates PLD is enabled: true.
hadPldGenerated boolean	Indicates PLD has been generated: true.
isVldEnabled boolean	Indicates Voter Level Data (VLD) is enabled: true.
hadVldGenerated boolean	Indicates VLD has been generated: true.
pgWorkspaceShare integer	Programmatic guaranteed Workspace share.
isTestCustomer boolean	Is test Customer.
inventory object	Inventory related configurations.
inventory object properties globalBlocklistMaxFileSize integer Global blocklist maximum file size.
campaign object	Campaign related configurations.
campaign object properties allowedMinBid integer Allowed minimum bid.
bidModel object	Bid model related configurations.
bidModel object properties minDuration integer Minimum duration. minDailyBudget integer Minimum daily budget. minDailyImpressions integer Minimum daily impressions.

JSON

Response examplesGet Customer config for AdvertiserGet Customer config for Workspace

Response 200

{
  "success": true,
  "data": {
    "organizationType": "advertiser",
    "hadPldGenerated": false,
    "pldRateForDiscount": 10,
    "pldMarkupPercentageForDiscount": 20,
    "slsRateForDiscount": 3,
    "slsMarkupPercentageForDiscount": 0,
    "pgCampaignFees": 10,
    "vertical": "political",
    "isBidShadingEnabled": true,
    "isPldEnabled": false,
    "hadVldGenerated": false,
    "isVldEnabled": false,
    "pgWorkspaceShare": 0,
    "isTestCustomer": false,
    "inventory": {
      "globalBlocklistMaxFileSize": 50000
    },
    "campaign": {
      "allowedMinBid": 1
    },
    "bidModel": {
      "minDuration": 30,
      "minDailyBudget": 100,
      "minDailyImpressions": 1000
    }
  }
}

Response 200

{
  "success": true,
  "data": {
    "organizationType": "workspace",
    "pldMarkupValue": 3,
    "pldRateForDiscount": 10,
    "pldMarkupPercentageForDiscount": 20,
    "pgCampaignFees": 10,
    "isBidShadingEnabled": false,
    "pgWorkspaceShare": 0,
    "pldMarkupTypeId": 1,
    "isTestCustomer": false,
    "inventory": {
      "globalBlocklistMaxFileSize": 50000
    },
    "campaign": {
      "allowedMinBid": 1
    },
    "bidModel": {
      "minDuration": 3,
      "minDailyBudget": 100,
      "minDailyImpressions": 1000
    }
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          isBidShadingEnabled: boolean;
          isTestCustomer: boolean;
        }
      };
    };
  };
}

function getCustomerConfig(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customer/config/{customerOwId}',
    params: {
      path: {
        customerOwId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Customer management

Invitation pre-requisite details

GET

Retrieve the pre-requisite details required before sending a Customer invitation, including whitelabel domain and support email configuration.

Response properties

workspaceDomain string	Workspace domain.
whiteLabelDomain string	Whitelabel domain.
isVerified boolean	Indicates the whitelabel domain is verified: true.
supportEmail string	Support email address.
isSupportEmailVerified boolean	Indicates the support email is verified: true.
organizationAppAccessible boolean	Indicates the Organization application is accessible: true.

JSON

Response 200

{
  "success": true,
  "data": {
    "workspaceDomain": "example-workspace",
    "whiteLabelDomain": "example-whitelabel",
    "isVerified": true,
    "supportEmail": "support@example.com",
    "isSupportEmailVerified": true,
    "organizationAppAccessible": true
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: {
          workspaceDomain: string;
          whiteLabelDomain: string;
          isVerified: boolean;
          supportEmail: string;
          isSupportEmailVerified: boolean;
          organizationAppAccessible: boolean;
        };
      };
    };
  };
}

function GetInvitationPreRequisite(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customer/invite/pre-requisite',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Invite Customer to platform

POST

An Organization already a part of the IQM platform can initiate an invite to create a new Organization for their Customer.

Refer to Customer operations resource properties for request schema.

This new Customer can be invited as a Workspace or an Advertiser with the following fields:

• email
• name
• password
• ownerUserName
• verticalId
• logoUrl
• customerOperationsDetails (Workspace only)

Response properties

successfulEmails array of strings	Invites successfully sent to specified emails.
failedEmails array of strings	Invites failed to send to specified emails.
message string	Success message.

JSON

Request sample

[
  {
    "email": "user1@iqm.com",
    "name": "ORG - 1",
    "password": "password@123",
    "ownerUserName": "User-1",
    "verticalId": 1,
    "logoUrl": "https://d3jme5si7t6llb.cloudfront.net/assets/202753/Pd7Xx26_1721991655891.png",
    "customerOperationDetails": {
      "customerTypeId": 2,
      "customerPaymentTypeId": 2,
      "countryId": 30100001,
      "adOpsAssigneeUserIds": [],
      "sellerAssigneeUserIds": [
        7184
      ],
      "labelIds": [
        7,
        8,
        9
      ]
    }
  }
]

Response 200

{
"success": true,
"data": {
  "successfulEmails": [
    "user1.g@iqm.com"
  ],
  "failedEmails": [
    "user2.p@iqm.com"
  ],
  "message": "1 invitations sent successfully."
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          successfulEmails: string[];
          failedEmails: string[];
          message: string;
        }
      }
    };
  };
};

function sendInvitations(): Promise < Responses > {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/invite',
    requestBody: {
      content: {
        "application/json": [
          {
            id?: `number`,
            invitedUserOWId?: `number`,
            email?: `string`,
            password?: `string`,
            name?: `string`,
            ownerUserName?: `string`,
            owId?: `number`,
            uowId?: `number`,
            modifiedByUOWId?: `number`,
            status?: `number`,
            expiresAt?: `number`,
            modifiedAt?: `string`,
            invitationUserType?: `string`,
            verticalId?: `number`,
            logoUrl?: `string`,
            serviceType?: `number`,
            customerOperationDetails?: {
              customerTypeId?: `number`,
              customerPaymentTypeId?: `number`,
              countryId?: `number`,
              createdByUowId?: `number`,
              modifiedByUowId?: `number`,
              adOpsAssigneeUserIds?: `array of numbers`,
              sellerAssigneeUserIds?: `array of numbers`,
              labelIds?: `array of numbers`,
            }
          }
        ]
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Resend Customer invite

POST

Resend Customer invite.

Request schema
inviteHash string	Invite hash.

Response properties

data string

Success message.

JSON

Request sample

{
    "inviteHash": "M7JoA2hYIUcKdVDM3g2KD/7+4FcOi9+slNVCW4NhEJgPMIxdvrj6ObD+gmCo6uikWqH6+LnHXnqXa7z2WVfw2FUI8ppsFOd8Ai1rnC0+gQiZWcgffqv2lggi0FZ3KiVERgAIFyJPIuV7fhi7AZksDka0VWHhNqHhX4R108psN73muXEaOrsf5uXlyQwzyYPpIeBq9eixIK+ytPQWBNMVKQBCczILN9l3MDheiiV94Jud1Tg/jrALspnF7KytcsfkgA5sQqWvK0K/LEl2TwAjMFl8fftW6d4xnwDb5Z0H"
}

Response 200

{
    "success": true,
    "data": "Invitation resent successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function CustomerRe-Invite(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/invite/re-send',
    requestBody: {
      content: {
        "application/json": {
          inviteHash: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Cancel Customer invite

DELETE

Query parameters
owId string	OW ID of Customer for whom to cancel an invite.

Response properties

data string

Success message.

JSON

Response 200

{
    "success": true,
    "data": "Invitation cancelled successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function CancelInvite(): Promise<Responses> {
  const options = {
    method: 'DELETE',
    url: 'https://api.iqm.com/api/v3/ua/customer/invite/cancel',
    params: {
      query: {
        owId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Customer Signup

POST

A Customer Organization can register itself using this endpoint. This will trigger the parent Organization to approve the new Customer signup. Once approved, an invitation email will be sent to complete the registration process.

Request schema
email string	Customer email.
organizationName string	Customer Organization name.
userName string	Customer user name.
industry integer	Industry type ID.
companySize integer	Company size type ID. +Supported values 1 1-10 2 11-50 3 51-200 4 201-500 5 501-1000 6 1001-5000 7 5000+
mediaBudget integer	Media budget ID. +Supported values 1 < $50,000 2 $50,000 - $100,000 3 $100,000 - $500,000 4 $500,000 - $1,000,000 5 $1,000,000 - $10,000,000 6 > $10,000,000
budgetSpent integer	Budget spent.

Response properties

data string

Success message.

JSON

Request sample

{
    "email": "email@domain.com",
    "organizationName": "Organisation Name",
    "userName": "User Name",
    "industry": 1,
    "companySize": 2,
    "mediaBudget": 3,
    "budgetSpent": 2000
}

Response 200

{
    "success": true,
    "data": "Customer sign up requested successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function Customersignup(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/signup',
    requestBody: {
      content: {
        "application/json": {
          email: `string`,
          organizationName: `string`,
          userName: `string`,
          industry: `number`,
          companySize: `number`,
          mediaBudget: `number`,
          budgetSpent: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Get Customer signup form

GET

Get a Customer sign-up form.

Response properties

isCustomerVerificationEnable boolean	Indicates whether Customer signup requires approval (true) or will be automatically approved (false).
customerFormDetails object	Customer form details.
campaignDetail object properties id integer Customer ID. field string Field. label string Label. isUserRequired boolean Indicates field will be required in Customer signup form: true.

JSON

Response 200

{
    "success": true,
    "data": {
        "isCustomerVerificationEnable": true,
        "customerFormDetails": [
            {
                "id": 1,
                "field": "organizationName",
                "label": "Organization name",
                "isUserRequired": true
            },
            {
                "id": 2,
                "field": "userName",
                "label": "Name of the user",
                "isUserRequired": true
            },
            {
                "id": 3,
                "field": "industry",
                "label": "Industry",
                "isUserRequired": false
            },
            {
                "id": 4,
                "field": "companySize",
                "label": "Company size",
                "isUserRequired": true
            },
            {
                "id": 5,
                "field": "mediaBudget",
                "label": "Media budget",
                "isUserRequired": true
            },
            {
                "id": 6,
                "field": "budgetSpent",
                "label": "Budget spent on programmatic",
                "isUserRequired": false
            }
        ]
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          isCustomerVerificationEnable: boolean;
          customerFormDetails: {
            id: number;
            field: string;
            label: string;
            isUserRequired: boolean;
          }[];
        };
      };
    };
  };
}

function GetCustomersignupform(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/customer/signup-form',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Assign Customer to user

POST

Assign a Customer to an existing user.

Request schema
owIds string	Comma separated OW IDs to assign to user.
uowIds string	Comma separated user IDs to assign Customers to.

Response properties

data string

Success message.

JSON

Request sample

{
    "owIds": "170,58,167,900",
    "uowIds": "166"
}

Response 200

{
    "success": true,
    "data": "Added Customer association to User successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        errorObjects: {
          error: string;
        }[];
        data: {
          successfulCustomerIds: number[];
        };
      };
    };
  };
}

function AssignCustomerstoUser(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/assign',
    requestBody: {
      content: {
        "application/json": {
          owIds: `string`,
          uowIds: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Share Customer with users

POST

Share access to a Customer with one or more users in the Organization.

Request schema
owIds array of integers	Customer Organization Workspace IDs to share.
uowIds array of integers	User Organization Workspace IDs to grant access.
logInAccessOwIds array of integers	Customer Organization Workspace IDs to grant login access.
removeLogInAccessOwIds array of integers	Customer Organization Workspace IDs to remove login access from.
removeOwIds array of integers	Customer Organization Workspace IDs to remove access from.
isLogInAccess boolean	Indicates the user has login access: true.
isCustomerAccess boolean	Indicates the user has Customer access: true.

JSON

Request sample

{
  "owIds": [12345],
  "uowIds": [67890],
  "isLogInAccess": false,
  "isCustomerAccess": true
}

Response 200

{
  "success": true,
  "data": "Customer shared successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function ShareCustomerWithUsers(body: {
  owIds?: number[];
  uowIds?: number[];
  logInAccessOwIds?: number[];
  removeLogInAccessOwIds?: number[];
  removeOwIds?: number[];
  isLogInAccess?: boolean;
  isCustomerAccess?: boolean;
}): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/user/customer/share',
    data: body,
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Unassign Customer from user

POST

Unassign a Customer from an existing user.

Request schema
owIds string	Comma separated OW IDs.
uowIds string	Comma separated user IDs.

Response properties

data string

Success message.

JSON

Request sample

{
    "owIds": "58",
    "uowIds": "166"
}

Response 200

{
    "success": true,
    "data": "Removed Customer association from User successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function De-assignCustomerFromUser(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/remove',
    requestBody: {
      content: {
        "application/json": {
          owIds: `string`,
          uowIds: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Approve Customer

PATCH

Approve a Customer and add app access.

Request schema
owId integer	Organization Workspace ID.
appIds string	Comma separated application IDs to add or revoke Customer access.

Response properties

data string

Success message.

JSON

Request sample

{
    "owId": 134562,
    "appIds": "2,5,6,7,9,10,11"
}

Response 200

{
  "success": true,
  "data": "Customer approved successfully."
}

More responses

Response 403

{
  "success": false,
  "errorObjects": [
    {
      "error": "User is not allowed to access provided customer"
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function Approvecustomer(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/customer/approve',
    requestBody: {
      content: {
        "application/json": {
          owIds: `number`,
          appIds: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Reject Customer

PATCH

Reject a Customer.

Request schema
owId integer	Organization Workspace ID.
statusReason string	Description of rejection reason.

Response properties

data string

Success message.

JSON

Request sample

{
    "owId": 345216,
    "statusReason": "Customer didn't provide correct details"
}

Response 200

{
    "success": true,
    "data": "Customer rejected successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function Rejectcustomer(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/customer/reject',
    requestBody: {
      content: {
        "application/json": {
          owIds: `number`,
          statusReason: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Add Customer app access

POST

Add Customer access to specified apps.

Request schema
owId integer	Organization Workspace ID.
appIds string	Comma separated application IDs to add or revoke Customer access.
accessLevel string	Gives Customer full or limited access to added applications.

Response properties

data string

Success message.

JSON

Request sample

{
    "owId": 2,
    "appIds": "1,2",
    "accessLevel": "Full"
}

Response 200

{
    "success": true,
    "data": "Application access added successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function AddAppaccessforCustomer(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/application/add',
    requestBody: {
      content: {
        "application/json": {
          owId: `number`,
          appIds: `string`,
          accessLevel: `string`
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Revoke Customer app access

POST

Revoke Customer access to specified apps.

Request schema
owId integer	Organization Workspace ID.
appIds string	Comma separated application IDs to add or revoke Customer access.
accessLevel string	Gives Customer full or limited access to added applications.

Response properties

data string

Success message.

JSON

Request sample

{
    "owId": 2,
    "appIds": "1,2",
}

Response 200

{
    "success": true,
    "data": "Application access revoked successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function RevokeAppaccessforCustomer(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer/application/revoke',
    requestBody: {
      content: {
        "application/json": {
          owId: `number`,
          appIds: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Put Customer on-hold

PATCH

Change Customer status (see status list) to 'on-hold' with provided reason.

Request schema
owId integer	Organization Workspace ID.
statusReason string	Description of reason to put Customer on hold.

Response properties

data string

Success message.

JSON

Request sample

{
    "owId": 54,
    "statusReason": "Not paid payment for 3 months"
}

Response 200

{
    "success": true,
    "data": "Customer status changed to on-hold successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function PutCustomerOn-hold(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/customer/hold',
    requestBody: {
      content: {
        "application/json": {
          owId: `number`,
          statusReason: `string`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Re-activate Customer

PATCH

Change Customer status to 'active.'

Request schema
owId integer	Customer OW ID to change status of.

Response properties

data string

Success message.

JSON

Request sample

{
    "owId": 54
}

Response 200

{
    "success": true,
    "data": "Customer status changed to active successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function Re-activateCustomer(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/customer/re-activate',
    requestBody: {
      content: {
        "application/json": {
          owId: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Add label for Customer operation

POST

Add a label for Customer operations, which will be displayed in the labels list.

Request schema
labelName string	Label name.

Response properties

labelId integer	Label ID.
message string	Success message.

JSON

Request sample

{
    "labelName": "Test-case-high"
}

Response 200

{
    "success": true,
    "data": {
        "labelId": 2,
        "message": "label added successfully"
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          labelId: number;
          message: string;
        }
      };
    };
  };
}

function addLabelForCustomerOperation(): Promise<Responses> {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/customer-operations/label/add',
    requestBody: {
      content: {
        "application/json": {
          labelName: `string`,
          createdByUowId: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Enable bid shading for Customer

PATCH

Enable bid shading for given Customer OW ID.

Path parameters
customerOwId integer	Customer Organization Workspace ID.

Response properties

message string

Success message.

JSON

Response 200

{
    "success": true,
    "data": "Bid Shading Enabled Successfully"
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
}

function updateIsBidShadingEnabledFlag(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/customer/enable-bid-shading/{customerOwId}',
    params: {
      path: {
        customerOwId: `number`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Customer operations details

PATCH

Update Customer operations details. See the Customer operations properties for request schema.

Path parameters
OwId integer	Customer Organization Workspace ID.

Response properties

message string

Success message.

JSON

Request sample

{
    "customerOperationsDetails": {
        "customerTypeId": 0,
        "customerPaymentTypeId": 0,
        "countryId": 0,
        "createdByUowId": 0,
        "modifiedByUowId": 0,
        "adOpsAssigneeUserIds": [
            0
        ],
        "sellerAssigneeUserIds": [
         0
        ],
        "labelIds": [
         0
        ]
    },
    "resetFields": {
        "customerTypeId": true,
        "customerPaymentTypeId": true,
        "countryId": true,
        "adOpsAssigneeUserIds": true,
        "sellerAssigneeUserIds": true,
        "labelIds": true
    }
}

Response 200

{
  "success": true,
  "data": {
    "message": "Customer operation details updated successfully"
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          message: string
        }
      };
    };
  };
}

function updateCustomerOperationDetailsByOwId(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/customer-operations/{owId}',
    params: {
      path: {
        owId: `number`
      }
    },
    requestBody: {
      content: {
        "application/json": {
          customerOperationsDetails?: {
            customerTypeId?: `number`,
            customerPaymentTypeId?: `number`,
            countryId?: `number`,
            createdByUowId?: `number`,
            modifiedByUowId?: `number`,
            adOpsAssigneeUserIds?: `array of numbers`,
            sellerAssigneeUserIds?: `array of numbers`,
            labelIds?: `array of numbers`,
          },
          resetFields?: {
            customerTypeId?: `boolean`,
            customerPaymentTypeId?: `boolean`,
            countryId?: `boolean`,
            adOpsAssigneeUserIds?: `boolean`,
            sellerAssigneeUserIds?: `boolean`,
            labelIds?: `boolean`,
          };
        };
      };
    };
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Advertiser management

An Advertiser is a Customer of a Workspace that places ads. This section covers the methods and endpoints for managing Advertiser details.

Advertiser resource properties

Resource properties
id integer	Advertiser ID.
advertiserName string	Advertiser name.
website string	Advertiser website.
chiefName string	Name of political person, with respect to the Advertiser.
contactNumber string	Advertiser phone number.
address string	Advertiser address.
legalInfo string	Legal info for Advertiser.
politicalIdentifier string	FEC ID or state equivalent for political parties.
links string	Associated links for Advertiser.

Get list of Advertiser profile and details

GET

Get a list of Advertiser profiles and their details.

Query parameters
advertiserIds string	Comma separated Advertiser IDs.
searchField string	Filter results by search field.
limit integer	Number of entries returned per page, default: 10.
pageNo integer	Page number of retrieved data, default: 1.

JSON

Response 200

{
  "success": true,
  "data": {
    "data": [
      {
        "advertiserName": "HG2",
        "website": "http://www.zws.iqm.com",
        "chiefName": "Ajay",
        "contactNumber": "1234567892",
        "address": "ghar2",
        "politicalIdentifier": "asdffv-@#%-c%^2~:",
        "id": 11112,
        "legalInfo": "na",
        "links": [
          "www.iqm.com"
        ]
      },
      {
        "advertiserName": "HG",
        "website": "http://www.zws.iqm.com",
        "chiefName": "Ajay Khatri",
        "contactNumber": "1234567890",
        "address": "ghar",
        "politicalIdentifier": null,
        "id": 11110,
        "legalInfo": "noting",
        "links": [
          "www.iqm.com"
        ]
      }
    ],
    "totalRecords": 2,
    "filteredRecords": 2
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          data: {
            id: number;
            advertiserName: string;
            website: string;
            chiefName: string;
            contactNumber: string;
            address: string | null;
            legalInfo: string | null;
            links: string[];
          }[];
          totalRecords: number;
          filteredRecords: number;
        };
      };
    };
  };
};

function Listadvertiserprofile(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/organization/advertisers/list',
    params: {
      query: {
        searchField: `string`,
        pageNo: `number`,
        limit: `number`,
        advertiserIds: `string`,
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Add Advertiser profile

POST

Add a new Advertiser profile. Refer to Advertiser resource properties for request schema.

Response properties

data string

Success message.

JSON

Request sample

{
  "advertiserName": "Acme Corp",
  "website": "https://acme.com",
  "chiefName": "John Doe",
  "contactNumber": "9876543210",
  "address": "123 Main St, City",
  "politicalIdentifier": "ID-12345",
  "legalInfo": "Registered",
  "links": [
    "https://acme.com/about"
  ]
}

Response 200

{
  "success": true,
  "data": "Advertiser profile added successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
};

function Addadvertiserprofile(): Promise < Responses > {
  const options = {
    method: 'POST',
    url: 'https://api.iqm.com/api/v3/ua/organization/advertisers/add',
    requestBody: {
      content: {
        "application/json": {
          advertiserName: `string`,
          website: `string`,
          chiefName: `string`,
          contactNumber: `string`,
          address: `string`,
          legalInfo: `string`,
          links: `array of strings`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Edit Advertiser profile

PATCH

Edit Advertiser profile details. Refer to Advertiser resource properties for request schema.

Path parameters
advertiserId integer	Advertiser ID.

Response properties

message string

Success message.

JSON

Request sample

{
  "id": 101,
  "advertiserName": "Acme Advertising Ltd.",
  "website": "https://www.acme-ads.com",
  "chiefName": "John Doe",
  "contactNumber": "+1-202-555-0178",
  "address": "123 Market Street, New York, NY, USA",
  "legalInfo": "Registered under Advertising Act, License #AD12345",
  "links": [
    "https://www.acme-ads.com/about"
  ],
  "politicalIdentifier": "FEC12345NY"
}

Response 200

{
    "success": true,
    "data": "Advertiser profile updated successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
};

function Editadvertiserprofile(): Promise < Responses > {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/ua/organization/advertiser/{advertiserId}',
    params: {
      path: {
        advertiserId: `number`
      }
    },
    requestBody: {
      content: {
        "application/json": {
          advertiserName: `string`,
          website: `string`,
          chiefName: `string`,
          contactNumber: `string`,
          address: `string`,
          legalInfo: `string`,
          links: `array of strings`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Delete Advertiser profile

DELETE

Delete an Advertiser profile.

Path parameters
advertiserId integer	Advertiser ID.

Response properties

message string

Success message.

JSON

Response 200

{
    "success": true,
    "data": "Advertiser profile deleted successfully."
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: string;
      };
    };
  };
};

function Deleteadvertiserprofile(): Promise < Responses > {
  const options = {
    method: 'DELETE',
    url: 'https://api.iqm.com/api/v3/ua/organization/advertiser/{advertiserId}',
    params: {
      path: {
        advertiserId: `number`
      }
    },
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

Static details lists

Application IDs

Application IDs
2	Dashboard.
3	Reports.
4	Bid Model.
5	Organization.
6	My Profile.
7	Campaigns.
8	Audiences.
9	Creatives.
10	Inventory.
17	Insights.
19	Planner.

Organization Workspace status

GET

Query parameters
view string	Represents the tab from which request was made in the Customer app. Supported values: customer, approval, finance.

Workspace status IDs
1	Active.
2	Pending.
3	Invited.
4	Suspended.
5	Rejected.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "name": "pending",
            "id": 2,
            "label": "Pending",
            "order": 1
        },
        {
            "name": "active",
            "id": 1,
            "label": "Active",
            "order": 2
        },
        {
            "name": "invited",
            "id": 3,
            "label": "Invited",
            "order": 3
        },
        {
            "name": "suspended",
            "id": 4,
            "label": "Suspended",
            "order": 4
        },
        {
            "name": "rejected",
            "id": 5,
            "label": "Rejected",
            "order": 5
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
        }[];
      };
    };
  };
}

function OrganizationWorkspaceStatus(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/organization-workspace-status',
    params: {
      query: {
        view: `string`,
      }
    },
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

User status

GET

Fetches the available statuses for user entities within Organizations and Workspaces.

User status IDs
1	Active.
2	Pending.
3	Invited.
4	Suspended.
5	Deleted.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "id": 2,
            "name": "pending",
            "order": 1,
            "label": "Pending"
        },
        {
            "id": 1,
            "name": "active",
            "order": 2,
            "label": "Active"
        },
        {
            "id": 3,
            "name": "invited",
            "order": 3,
            "label": "Invited"
        },
        {
            "id": 4,
            "name": "suspended",
            "order": 4,
            "label": "Suspended"
        },
        {
            "id": 5,
            "name": "deleted",
            "order": 5,
            "label": "Deleted"
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
        }[];
      };
    };
  };
}

function UserStatus(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/user-status',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Customer type

GET

Identifies what kind of services the Customer has chosen.

Customer type IDs
1	Self-served.
2	Managed Services.
3	App users.
4	Advertisers.
5	Workspaces.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "name": "self_served",
            "id": 1,
            "label": "Self Served",
            "order": 2
        },
        {
            "name": "managed_services",
            "id": 2,
            "label": "Managed Services ",
            "order": 1
        },
        {
            "name": "app_users",
            "id": 3,
            "label": "App Users",
            "order": 3
        },
        {
            "name": "advertisers",
            "id": 4,
            "label": "Advertisers",
            "order": 4
        },
        {
            "name": "workspaces",
            "id": 5,
            "label": "Workspaces",
            "order": 5
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
        }[];
      };
    };
  };
}

function CustomerType(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/customer-type',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Customer payment type

GET

Customer payment type IDs
1	Prepaid.
2	Postpaid.

JSON

Response 200

{
  "success": true,
  "data": {
    "totalRecords": 2,
    "filteredRecords": 2,
    "customerPaymentTypes": [
      {
        "name": "prepaid",
        "id": 1,
        "label": "PrePaid",
        "order": 1
      },
      {
        "name": "postpaid",
        "id": 2,
        "label": "PostPaid",
        "order": 2
      }
    ]
  }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          totalRecords: number;
          filteredRecords: number;
          customerPaymentTypes: {
            name: string;
            id: number;
            label: string;
            order: number;
          }[]
        }
      }
    };
  };
};

function getCustomerPaymentType(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/customer-payment-types',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Customer account type

GET

Customer account type IDs
1	Advertiser.
2	Workspace.

JSON

Response 200

{
    "success": true,
    "data": {
        "totalRecords": 2,
        "filteredRecords": 2,
        "customerAccountTypes": [
            {
                "name": "advertiser",
                "id": 1,
                "label": "Advertiser",
                "order": 1
            },
            {
                "name": "workspace",
                "id": 2,
                "label": "Workspace",
                "order": 2
            }
        ]
    }
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          totalRecords: number;
          filteredRecords: number;
          customerAccountTypes: {
            name: string;
            id: number;
            label: string;
            order: number;
          }[]
        }
      };
    };
  };
}

function getCustomerAccountType(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/customer-account-types',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Customer list sortable fields

GET

Sortable fields
status	Status.
createdAt	Date of joining.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "label": "Status",
            "field": "status",
            "order": 1
        },
        {
            "label": "Date of joining",
            "field": "createdAt",
            "order": 2
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          label: string;
          field: string;
          order: number
        }[];
      };
    };
  };
}

function CustomerListSortableFieldsAPI(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/customer-list-sortable-field',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

User sort by options

GET

Fetches the available fields by which the user list can be sorted.

Sortable fields
displayName	Display Name.
email	Email.
status	Status.

JSON

Response 200

{
    "success": true,
    "data": [
        {
            "name": "displayName",
            "label": "Display Name",
            "order": 1
        },
        {
            "name": "email",
            "label": "Email",
            "order": 2
        },
        {
            "name": "status",
            "label": "Status",
            "order": 3
        }
    ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          label: string;
          order: number;
        }[];
      };
    };
  };
}

function UserSortBy(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/user-sort-by',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Organization expertise

GET

Organization expertise IDs
1	Account Administration.
2	Campaign Optimization.
3	Creative Services.
4	Audience building.
5	Inventory Management.
6	Finance & Accounting.
7	Campaign Creation.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "name": "account_administration",
      "id": 1,
      "label": "Account Administration",
      "order": 1
    },
    {
      "name": "campaign_optimization",
      "id": 2,
      "label": "Campaign Optimization",
      "order": 2
    },
    {
      "name": "creative_serivces",
      "id": 3,
      "label": "Creative Services",
      "order": 3
    },
    {
      "name": "audience_building",
      "id": 4,
      "label": "Audience Building",
      "order": 4
    },
    {
      "name": "inventory_management",
      "id": 5,
      "label": "Inventory Management",
      "order": 5
    },
    {
      "name": "finance_and_accounting",
      "id": 6,
      "label": "Finance & Accounting",
      "order": 6
    },
    {
      "name": "campaign_creation",
      "id": 7,
      "label": "Campaign Creation",
      "order": 7
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
        }[];
      };
    };
  };
};

function OrganizationExpertize(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/organization-expertize',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Company size

GET

Company size IDs
1	1-10 employees.
2	11-50 employees.
3	51-200 employees.
4	201-500 employees.
5	501-1000 employees.
6	1001-5000 employees.
7	5000+ employees.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "name": "1_10",
      "id": 1,
      "label": "1-10",
      "order": 1
    },
    {
      "name": "11_50",
      "id": 2,
      "label": "11-50",
      "order": 2
    },
    {
      "name": "51_200",
      "id": 3,
      "label": "51-200",
      "order": 3
    },
    {
      "name": "201_500",
      "id": 4,
      "label": "201-500",
      "order": 4
    },
    {
      "name": "501_1000",
      "id": 5,
      "label": "501-1000",
      "order": 5
    },
    {
      "name": "1001_5000",
      "id": 6,
      "label": "1001-5000",
      "order": 6
    },
    {
      "name": "5000+",
      "id": 7,
      "label": "5000+",
      "order": 7
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
        }[];
      };
    };
  };
};

function Companysize(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/company-size',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Industries

GET

Get a list of industry IDs.

Response properties

name string	Industry name.
id integer	Industry ID.
label string	Industry label.
order integer	Order.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "name": "accounting",
      "id": 1,
      "label": "Accounting ",
      "order": 1
    },
    {
      "name": "airlines/aviation",
      "id": 2,
      "label": "Airlines/Aviation",
      "order": 2
    },
    {
      "name": "alternative_dispute_resolution",
      "id": 3,
      "label": "Alternative Dispute Resolution",
      "order": 3
    },
    {
      "name": "alternative_medicine",
      "id": 4,
      "label": "Alternative Medicine",
      "order": 4
    },
    {
      "name": "animation",
      "id": 5,
      "label": "Animation",
      "order": 5
    },
    {
      "name": "apparel/fashion",
      "id": 6,
      "label": "Apparel/Fashion",
      "order": 6
    },
    {
      "name": "architecture/planning",
      "id": 7,
      "label": "Architecture/Planning",
      "order": 7
    },
    {
      "name": "arts/crafts",
      "id": 8,
      "label": "Arts/Crafts",
      "order": 8
    },
    {
      "name": "automotive",
      "id": 9,
      "label": "Automotive",
      "order": 9
    },
    {
      "name": "aviation/aerospace",
      "id": 10,
      "label": "Aviation/Aerospace",
      "order": 10
    },
    {
      "name": "banking/mortgage",
      "id": 11,
      "label": "Banking/Mortgage",
      "order": 11
    },
    {
      "name": "biotechnology/greentech",
      "id": 12,
      "label": "Biotechnology/Greentech",
      "order": 12
    },
    {
      "name": "broadcast_media",
      "id": 13,
      "label": "Broadcast Media",
      "order": 13
    },
    {
      "name": "building_materials",
      "id": 14,
      "label": "Building Materials",
      "order": 14
    },
    {
      "name": "business_supplies/equipment",
      "id": 15,
      "label": "Business Supplies/Equipment",
      "order": 15
    },
    {
      "name": "capital_markets/hedge_fund/private_equity",
      "id": 16,
      "label": "Capital Markets/Hedge Fund/Private Equity",
      "order": 16
    },
    {
      "name": "chemicals",
      "id": 17,
      "label": "Chemicals",
      "order": 17
    },
    {
      "name": "civic/social_organization",
      "id": 18,
      "label": "Civic/Social Organization",
      "order": 18
    },
    {
      "name": "civil_engineering",
      "id": 19,
      "label": "Civil Engineering",
      "order": 19
    },
    {
      "name": "commercial_real_estate",
      "id": 20,
      "label": "Commercial Real Estate",
      "order": 20
    },
    {
      "name": "computer_games",
      "id": 21,
      "label": "Computer Games",
      "order": 21
    },
    {
      "name": "computer_hardware",
      "id": 22,
      "label": "Computer Hardware",
      "order": 22
    },
    {
      "name": "computer_networking",
      "id": 23,
      "label": "Computer Networking",
      "order": 23
    },
    {
      "name": "computer_software/engineering",
      "id": 24,
      "label": "Computer Software/Engineering",
      "order": 24
    },
    {
      "name": "computer/network_security",
      "id": 25,
      "label": "Computer/Network Security",
      "order": 25
    },
    {
      "name": "construction",
      "id": 26,
      "label": "Construction",
      "order": 26
    },
    {
      "name": "consumer_electronics",
      "id": 27,
      "label": "Consumer Electronics",
      "order": 27
    },
    {
      "name": "consumer_goods",
      "id": 28,
      "label": "Consumer Goods",
      "order": 28
    },
    {
      "name": "consumer_services",
      "id": 29,
      "label": "Consumer Services",
      "order": 29
    },
    {
      "name": "cosmetics",
      "id": 30,
      "label": "Cosmetics",
      "order": 30
    },
    {
      "name": "dairy",
      "id": 31,
      "label": "Dairy",
      "order": 31
    },
    {
      "name": "defense/space",
      "id": 32,
      "label": "Defense/Space",
      "order": 32
    },
    {
      "name": "design",
      "id": 33,
      "label": "Design",
      "order": 33
    },
    {
      "name": "e-learning",
      "id": 34,
      "label": "E-Learning",
      "order": 34
    },
    {
      "name": "education_management",
      "id": 35,
      "label": "Education Management",
      "order": 35
    },
    {
      "name": "electrical/electronic_manufacturing",
      "id": 36,
      "label": "Electrical/Electronic Manufacturing",
      "order": 36
    },
    {
      "name": "entertainment/movie_production",
      "id": 37,
      "label": "Entertainment/Movie Production",
      "order": 37
    },
    {
      "name": "environmental_services",
      "id": 38,
      "label": "Environmental Services",
      "order": 38
    },
    {
      "name": "events_services",
      "id": 39,
      "label": "Events Services",
      "order": 39
    },
    {
      "name": "executive_office",
      "id": 40,
      "label": "Executive Office",
      "order": 40
    },
    {
      "name": "facilities_services",
      "id": 41,
      "label": "Facilities Services",
      "order": 41
    },
    {
      "name": "farming",
      "id": 42,
      "label": "Farming",
      "order": 42
    },
    {
      "name": "financial_services",
      "id": 43,
      "label": "Financial Services",
      "order": 43
    },
    {
      "name": "fine_art",
      "id": 44,
      "label": "Fine Art",
      "order": 44
    },
    {
      "name": "fishery",
      "id": 45,
      "label": "Fishery",
      "order": 45
    },
    {
      "name": "food_production",
      "id": 46,
      "label": "Food Production",
      "order": 46
    },
    {
      "name": "food/beverages",
      "id": 47,
      "label": "Food/Beverages",
      "order": 47
    },
    {
      "name": "fundraising",
      "id": 48,
      "label": "Fundraising",
      "order": 48
    },
    {
      "name": "furniture",
      "id": 49,
      "label": "Furniture",
      "order": 49
    },
    {
      "name": "gambling/casinos",
      "id": 50,
      "label": "Gambling/Casinos",
      "order": 50
    },
    {
      "name": "glass/ceramics/concrete",
      "id": 51,
      "label": "Glass/Ceramics/Concrete",
      "order": 51
    },
    {
      "name": "government_administration",
      "id": 52,
      "label": "Government Administration",
      "order": 52
    },
    {
      "name": "government_relations",
      "id": 53,
      "label": "Government Relations",
      "order": 53
    },
    {
      "name": "graphic_design/web_design",
      "id": 54,
      "label": "Graphic Design/Web Design",
      "order": 54
    },
    {
      "name": "health/fitness",
      "id": 55,
      "label": "Health/Fitness",
      "order": 55
    },
    {
      "name": "higher_education/acadamia",
      "id": 56,
      "label": "Higher Education/Acadamia",
      "order": 56
    },
    {
      "name": "hospital/health_care",
      "id": 57,
      "label": "Hospital/Health Care",
      "order": 57
    },
    {
      "name": "hospitality",
      "id": 58,
      "label": "Hospitality",
      "order": 58
    },
    {
      "name": "human_resources/hr",
      "id": 59,
      "label": "Human Resources/HR",
      "order": 59
    },
    {
      "name": "import/export",
      "id": 60,
      "label": "Import/Export",
      "order": 60
    },
    {
      "name": "individual/family_services",
      "id": 61,
      "label": "Individual/Family Services",
      "order": 61
    },
    {
      "name": "industrial_automation",
      "id": 62,
      "label": "Industrial Automation",
      "order": 62
    },
    {
      "name": "information_services",
      "id": 63,
      "label": "Information Services",
      "order": 63
    },
    {
      "name": "information_technology/it",
      "id": 64,
      "label": "Information Technology/IT",
      "order": 64
    },
    {
      "name": "insurance",
      "id": 65,
      "label": "Insurance",
      "order": 65
    },
    {
      "name": "international_affairs",
      "id": 66,
      "label": "International Affairs",
      "order": 66
    },
    {
      "name": "international_trade/development",
      "id": 67,
      "label": "International Trade/Development",
      "order": 67
    },
    {
      "name": "internet",
      "id": 68,
      "label": "Internet",
      "order": 68
    },
    {
      "name": "investment_banking/venture",
      "id": 69,
      "label": "Investment Banking/Venture",
      "order": 69
    },
    {
      "name": "investment_management/hedge_fund/private_equity",
      "id": 70,
      "label": "Investment Management/Hedge Fund/Private Equity",
      "order": 70
    },
    {
      "name": "judiciary",
      "id": 71,
      "label": "Judiciary",
      "order": 71
    },
    {
      "name": "law_enforcement",
      "id": 72,
      "label": "Law Enforcement",
      "order": 72
    },
    {
      "name": "law_practice/law_firms",
      "id": 73,
      "label": "Law Practice/Law Firms",
      "order": 73
    },
    {
      "name": "legal_services",
      "id": 74,
      "label": "Legal Services",
      "order": 74
    },
    {
      "name": "legislative_office",
      "id": 75,
      "label": "Legislative Office",
      "order": 75
    },
    {
      "name": "leisure/travel",
      "id": 76,
      "label": "Leisure/Travel",
      "order": 76
    },
    {
      "name": "library",
      "id": 77,
      "label": "Library",
      "order": 77
    },
    {
      "name": "logistics/procurement",
      "id": 78,
      "label": "Logistics/Procurement",
      "order": 78
    },
    {
      "name": "luxury_goods/jewelry",
      "id": 79,
      "label": "Luxury Goods/Jewelry",
      "order": 79
    },
    {
      "name": "machinery",
      "id": 80,
      "label": "Machinery",
      "order": 80
    },
    {
      "name": "management_consulting",
      "id": 81,
      "label": "Management Consulting",
      "order": 81
    },
    {
      "name": "maritime",
      "id": 82,
      "label": "Maritime",
      "order": 82
    },
    {
      "name": "market_research",
      "id": 83,
      "label": "Market Research",
      "order": 83
    },
    {
      "name": "marketing/advertising/sales",
      "id": 84,
      "label": "Marketing/Advertising/Sales",
      "order": 84
    },
    {
      "name": "mechanical_or_industrial_engineering",
      "id": 85,
      "label": "Mechanical or Industrial Engineering",
      "order": 85
    },
    {
      "name": "media_production",
      "id": 86,
      "label": "Media Production",
      "order": 86
    },
    {
      "name": "medical_equipment",
      "id": 87,
      "label": "Medical Equipment",
      "order": 87
    },
    {
      "name": "medical_practice",
      "id": 88,
      "label": "Medical Practice",
      "order": 88
    },
    {
      "name": "mental_health_care",
      "id": 89,
      "label": "Mental Health Care",
      "order": 89
    },
    {
      "name": "military_industry",
      "id": 90,
      "label": "Military Industry",
      "order": 90
    },
    {
      "name": "mining/metals",
      "id": 91,
      "label": "Mining/Metals",
      "order": 91
    },
    {
      "name": "motion_pictures/film",
      "id": 92,
      "label": "Motion Pictures/Film",
      "order": 92
    },
    {
      "name": "museums/institutions",
      "id": 93,
      "label": "Museums/Institutions",
      "order": 93
    },
    {
      "name": "music",
      "id": 94,
      "label": "Music",
      "order": 94
    },
    {
      "name": "nanotechnology",
      "id": 95,
      "label": "Nanotechnology",
      "order": 95
    },
    {
      "name": "newspapers/journalism",
      "id": 96,
      "label": "Newspapers/Journalism",
      "order": 96
    },
    {
      "name": "non-profit/volunteering",
      "id": 97,
      "label": "Non-Profit/Volunteering",
      "order": 97
    },
    {
      "name": "oil/energy/solar/greentech",
      "id": 98,
      "label": "Oil/Energy/Solar/Greentech",
      "order": 98
    },
    {
      "name": "online_publishing",
      "id": 99,
      "label": "Online Publishing",
      "order": 99
    },
    {
      "name": "other_industry",
      "id": 100,
      "label": "Other Industry",
      "order": 100
    },
    {
      "name": "outsourcing/offshoring",
      "id": 101,
      "label": "Outsourcing/Offshoring",
      "order": 101
    },
    {
      "name": "package/freight_delivery",
      "id": 102,
      "label": "Package/Freight Delivery",
      "order": 102
    },
    {
      "name": "packaging/containers",
      "id": 103,
      "label": "Packaging/Containers",
      "order": 103
    },
    {
      "name": "paper/forest_products",
      "id": 104,
      "label": "Paper/Forest Products",
      "order": 104
    },
    {
      "name": "performing_arts",
      "id": 105,
      "label": "Performing Arts",
      "order": 105
    },
    {
      "name": "pharmaceuticals",
      "id": 106,
      "label": "Pharmaceuticals",
      "order": 106
    },
    {
      "name": "philanthropy",
      "id": 107,
      "label": "Philanthropy",
      "order": 107
    },
    {
      "name": "photography",
      "id": 108,
      "label": "Photography",
      "order": 108
    },
    {
      "name": "plastics",
      "id": 109,
      "label": "Plastics",
      "order": 109
    },
    {
      "name": "political_organization",
      "id": 110,
      "label": "Political Organization",
      "order": 110
    },
    {
      "name": "primary/secondary_education",
      "id": 111,
      "label": "Primary/Secondary Education",
      "order": 111
    },
    {
      "name": "printing",
      "id": 112,
      "label": "Printing",
      "order": 112
    },
    {
      "name": "professional_training",
      "id": 113,
      "label": "Professional Training",
      "order": 113
    },
    {
      "name": "program_development",
      "id": 114,
      "label": "Program Development",
      "order": 114
    },
    {
      "name": "public_relations/pr",
      "id": 115,
      "label": "Public Relations/PR",
      "order": 115
    },
    {
      "name": "public_safety",
      "id": 116,
      "label": "Public Safety",
      "order": 116
    },
    {
      "name": "publishing_industry",
      "id": 117,
      "label": "Publishing Industry",
      "order": 117
    },
    {
      "name": "railroad_manufacture",
      "id": 118,
      "label": "Railroad Manufacture",
      "order": 118
    },
    {
      "name": "ranching",
      "id": 119,
      "label": "Ranching",
      "order": 119
    },
    {
      "name": "real_estate/mortgage",
      "id": 120,
      "label": "Real Estate/Mortgage",
      "order": 120
    },
    {
      "name": "recreational_facilities/services",
      "id": 121,
      "label": "Recreational Facilities/Services",
      "order": 121
    },
    {
      "name": "religious_institutions",
      "id": 122,
      "label": "Religious Institutions",
      "order": 122
    },
    {
      "name": "renewables/environment",
      "id": 123,
      "label": "Renewables/Environment",
      "order": 123
    },
    {
      "name": "research_industry",
      "id": 124,
      "label": "Research Industry",
      "order": 124
    },
    {
      "name": "restaurants",
      "id": 125,
      "label": "Restaurants",
      "order": 125
    },
    {
      "name": "retail_industry",
      "id": 126,
      "label": "Retail Industry",
      "order": 126
    },
    {
      "name": "security/investigations",
      "id": 127,
      "label": "Security/Investigations",
      "order": 127
    },
    {
      "name": "semiconductors",
      "id": 128,
      "label": "Semiconductors",
      "order": 128
    },
    {
      "name": "shipbuilding",
      "id": 129,
      "label": "Shipbuilding",
      "order": 129
    },
    {
      "name": "sporting_goods",
      "id": 130,
      "label": "Sporting Goods",
      "order": 130
    },
    {
      "name": "sports",
      "id": 131,
      "label": "Sports",
      "order": 131
    },
    {
      "name": "staffing/recruiting",
      "id": 132,
      "label": "Staffing/Recruiting",
      "order": 132
    },
    {
      "name": "supermarkets",
      "id": 133,
      "label": "Supermarkets",
      "order": 133
    },
    {
      "name": "telecommunications",
      "id": 134,
      "label": "Telecommunications",
      "order": 134
    },
    {
      "name": "textiles",
      "id": 135,
      "label": "Textiles",
      "order": 135
    },
    {
      "name": "think_tanks",
      "id": 136,
      "label": "Think Tanks",
      "order": 136
    },
    {
      "name": "tobacco",
      "id": 137,
      "label": "Tobacco",
      "order": 137
    },
    {
      "name": "translation/localization",
      "id": 138,
      "label": "Translation/Localization",
      "order": 138
    },
    {
      "name": "transportation",
      "id": 139,
      "label": "Transportation",
      "order": 139
    },
    {
      "name": "utilities",
      "id": 140,
      "label": "Utilities",
      "order": 140
    },
    {
      "name": "venture_capital/vc",
      "id": 141,
      "label": "Venture Capital/VC",
      "order": 141
    },
    {
      "name": "veterinary",
      "id": 142,
      "label": "Veterinary",
      "order": 142
    },
    {
      "name": "warehousing",
      "id": 143,
      "label": "Warehousing",
      "order": 143
    },
    {
      "name": "wholesale",
      "id": 144,
      "label": "Wholesale",
      "order": 144
    },
    {
      "name": "wine/spirits",
      "id": 145,
      "label": "Wine/Spirits",
      "order": 145
    },
    {
      "name": "wireless",
      "id": 146,
      "label": "Wireless",
      "order": 146
    },
    {
      "name": "writing/editing",
      "id": 147,
      "label": "Writing/Editing",
      "order": 147
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
        }[];
      };
    };
  };
};

function Industries(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/industries',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Media budget

GET

Media budget IDs
1	< $50,000.
2	$50,000 - $100,000.
3	$100,000 - $500,000.
4	$500,000 - $1,000,000.
5	$1,000,000 - $10,000,000.
6	> $10,000,000.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "name": "<50,000",
      "id": 1,
      "label": "< $50,000",
      "order": 1
    },
    {
      "name": "50,000_100,000",
      "id": 2,
      "label": "$50,000 - $100,000",
      "order": 2
    },
    {
      "name": "100,000_500,000",
      "id": 3,
      "label": "$100,000 - $500,000",
      "order": 3
    },
    {
      "name": "500,000_1,000,000",
      "id": 4,
      "label": "$500,000 - $1,000,000",
      "order": 4
    },
    {
      "name": "1,000,000_10,000,000",
      "id": 5,
      "label": "$1,000,000 - $10,000,000",
      "order": 5
    },
    {
      "name": ">10,000,000",
      "id": 6,
      "label": "> $10,000,000",
      "order": 6
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
        }[];
      };
    };
  };
};

function Mediabudget(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/media-budget',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Verticals

GET

Verticals IDs
1 Political	This vertical caters to Advertisers from the Political domain targeting users for issue advocacy, persuasion, event promotion, fundraising and other type of campaigns.
2 Healthcare	This vertical caters to Advertisers from domains such as pharmaceutical and medical equipment manufacturers targeting healthcare professionals.
3 Specialty	This vertical caters to Advertisers from niche domains such as automobiles, finance, retail, travel, B2B and others.

JSON

Response 200

{
  "success": true,
  "data": [
    {
      "name": "political",
      "id": 1,
      "label": "Political",
      "order": 1,
      "description": "This caters to Advertisers from the political domain targeting users for for issue advocacy, persuasion, event promotion, fundraising and other type of campaigns"
    },
    {
      "name": "healthcare",
      "id": 2,
      "label": "Healthcare",
      "order": 2,
      "description": "This caters to Advertisers from domains such as pharmaceutical and medical equipment manufacturers targeting healthcare professionals."
    },
    {
      "name": "specialty",
      "id": 3,
      "label": "Specialty",
      "order": 11,
      "description": "This caters to Advertisers from niche domains such as automobiles, finance, retail, travel, B2B and others."
    }
  ]
}

TypeScript

See TypeScript prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          name: string;
          id: number;
          label: string;
          order: number;
          description: string;
        }[];
      };
    };
  };
};

function getVerticals(): Promise < Responses > {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/ua/static/verticals',
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}