Skip to main content
Tools Reference

IT Glue Tools

Written By Christopher Scaminaci

Last updated 7 days ago

IT Glue Tools

itg_ · 149 tools · Free 65 · Pro 84 Static x-api-key; JSON:API envelope; page[number]/page[size] (max 1000); regional base URL; password-access capability probe.

All connector tools · IT Glue setup guide

IT Glue tool groups

Organizations & Locations

ToolPlanAccessSummary
itg_bulk_delete_locationsProDestructiveBulk-delete multiple locations by ID.
itg_bulk_delete_organizationsProDestructiveBulk-delete multiple organizations by ID.
itg_bulk_update_locationsProWriteBulk-update multiple locations in a single request.
itg_bulk_update_organizationsProWriteBulk-update multiple organizations in a single request.
itg_create_locationProWriteCreate a new location.
itg_create_organizationProWriteCreate a new organization.
itg_get_locationFreeRead-onlyRetrieve full details for a single location by ID.
itg_get_organizationFreeRead-onlyRetrieve full details for a single organization by ID.
itg_list_locationsFreeRead-onlyList locations (physical sites).
itg_list_organizationsFreeRead-onlyList organizations (companies/clients).
itg_update_locationProWriteUpdate an existing location (PATCH semantics — only provided fields are updated).
itg_update_organizationProWriteUpdate an existing organization.

[IT Glue] Bulk-delete multiple locations by ID. Accepts a JSON array of resource objects with {"type":"locations","id":"<id>"}. This action is destructive — verify IDs before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"locations","id":"1"},{"type":"locations","id":"2"}].

[IT Glue] Bulk-delete multiple organizations by ID. Accepts a JSON array of resource objects with {"type":"organizations","id":"<id>"}. This action is destructive and cascades to child resources — verify IDs carefully before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"organizations","id":"1"},{"type":"organizations","id":"2"}].

[IT Glue] Bulk-update multiple locations in a single request. Accepts a JSON:API data array where each element contains {"type":"locations","id":"<id>","attributes":}. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"locations","id":"1","attributes":{"name":"New Name"}}].

[IT Glue] Bulk-update multiple organizations in a single request. Accepts a JSON:API data array. Each element must include {"type":"organizations","id":"<id>","attributes":}. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"organizations","id":"1","attributes":{"name":"New Name"}}].

[IT Glue] Create a new location. If organizationId is supplied, scopes to that organization (recommended); otherwise the organization_id must be embedded in the relationships block of the attributes. Returns the created location with its assigned ID.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with location attributes. Example: {"name":"Denver HQ","address_1":"123 Main St","city":"Denver","region_id":5,"country_id":1}.
organizationIdintegernonullOptional organization ID. When provided, location is created nested under that organization (preferred).

[IT Glue] Create a new organization. Accepts a JSON object containing JSON:API attributes. Example: {"name":"Acme Corp","organization_type_id":123,"organization_status_id":456,"description":"Primary client"}. Returns the created organization with its assigned ID.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with organization attributes. At minimum supply 'name'. Example: {"name":"Acme Corp","organization_type_id":123,"organization_status_id":456}.

[IT Glue] Retrieve full details for a single location by ID. Returns the full JSON:API resource object. Use itg_list_locations to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue location ID. Use itg_list_locations to find valid IDs.

[IT Glue] Retrieve full details for a single organization by ID. Returns the full JSON:API resource object including attributes and relationships. Use itg_list_organizations to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue organization ID. Use itg_list_organizations to find valid IDs.

[IT Glue] List locations (physical sites). If organizationId is supplied, scopes to that organization's locations; otherwise lists locations across all organizations. Supports filtering by name, city, region_id, country_id. Returns paginated JSON:API envelope.

ParamTypeRequiredDefaultDescription
filterCitystringnonullFilter by city name.
filterCountryIdintegernonullFilter by country_id. Use itg_list_countries to find valid IDs.
filterNamestringnonullFilter by location name.
filterRegionIdintegernonullFilter by region_id. Use itg_list_regions to find valid IDs.
organizationIdintegernonullOptional organization ID. When provided, only returns locations for that organization. Use itg_list_organizations to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] List organizations (companies/clients). Supports filtering by name, organization_status_id, organization_type_id. Returns paginated JSON:API envelope with {data: [...], meta: {total-count, ...}}. Use itg_get_organization with a specific id for full details.

ParamTypeRequiredDefaultDescription
filterNamestringnonullFilter by organization name (partial match).
filterStatusIdintegernonullFilter by organization-status-id. Use itg_list_organization_statuses to find valid IDs.
filterTypeIdintegernonullFilter by organization-type-id. Use itg_list_organization_types to find valid IDs.
includeFullMetabooleannofalseWhen true, returns the complete unshaped upstream response (including the meta.filters permitted-value catalogs). Leave false for the leaner default.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending (e.g. -updated_at).

[IT Glue] Update an existing location (PATCH semantics — only provided fields are updated). Returns the updated location. Use itg_get_location to check current values before updating.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with location attributes to update. Example: {"name":"Denver HQ (Updated)","phone":"555-0100"}.
idintegeryesThe IT Glue location ID to update. Use itg_list_locations to find valid IDs.

[IT Glue] Update an existing organization. Accepts JSON:API attributes (PATCH semantics — only provided fields are updated). Example: {"name":"Acme Corp Updated","description":"New description"}. Returns the updated organization.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with organization attributes to update. Example: {"name":"Acme Corp Updated","description":"New description"}.
idintegeryesThe IT Glue organization ID to update. Use itg_list_organizations to find valid IDs.

Contacts

ToolPlanAccessSummary
itg_bulk_delete_contactsProDestructiveBulk-delete multiple contacts by ID.
itg_bulk_update_contactsProWriteBulk-update multiple contacts in a single request.
itg_create_contactProWriteCreate a new contact.
itg_get_contactFreeRead-onlyRetrieve full details for a single contact by ID.
itg_list_contactsFreeRead-onlyList contacts (people attached to organizations).
itg_update_contactProWriteUpdate an existing contact (PATCH semantics — only provided fields are updated).

[IT Glue] Bulk-delete multiple contacts by ID. Accepts a JSON array of resource objects with {"type":"contacts","id":"<id>"}. This action is destructive — verify IDs before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"contacts","id":"1"},{"type":"contacts","id":"2"}].

[IT Glue] Bulk-update multiple contacts in a single request. Accepts a JSON:API data array where each element contains {"type":"contacts","id":"<id>","attributes":}. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"contacts","id":"1","attributes":{"title":"Director"}}].

[IT Glue] Create a new contact. Requires at minimum first_name, last_name, and the organization_id (either in attributes or the embedded relationship). Example: {"first_name":"Jane","last_name":"Doe","organization_id":123,"title":"IT Manager","contact_emails":[{"value":"jane@acme.com","primary":true}]}. Returns the created contact.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with contact attributes. Example: {"first_name":"Jane","last_name":"Doe","organization_id":123,"title":"IT Manager"}.

[IT Glue] Retrieve full details for a single contact by ID. Returns the full JSON:API resource object including contact emails, phones, and organization relationship. Use itg_list_contacts to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue contact ID. Use itg_list_contacts to find valid IDs.

[IT Glue] List contacts (people attached to organizations). If organizationId is supplied, scopes to that organization's contacts; otherwise lists contacts across all organizations. Supports filtering by name, title, contact_type_id, important, primary_email. Returns paginated JSON:API envelope.

ParamTypeRequiredDefaultDescription
filterContactTypeIdintegernonullFilter by contact_type_id. Use itg_list_contact_types to find valid IDs.
filterFirstNamestringnonullFilter by contact first_name (partial match).
filterImportantbooleannonullFilter to important contacts only when true.
filterLastNamestringnonullFilter by contact last_name (partial match).
filterPrimaryEmailstringnonullFilter by primary email address (partial match).
filterTitlestringnonullFilter by job title.
organizationIdintegernonullOptional organization ID. When provided, only returns contacts for that organization. Use itg_list_organizations to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, first_name, last_name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] Update an existing contact (PATCH semantics — only provided fields are updated). Returns the updated contact. Use itg_get_contact to check current values before updating.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with contact attributes to update. Example: {"title":"Senior IT Manager","notes":"Promoted Q1"}.
idintegeryesThe IT Glue contact ID to update. Use itg_list_contacts to find valid IDs.

Configurations & Network

ToolPlanAccessSummary
itg_bulk_delete_configurationsProDestructiveBulk-delete multiple configurations by ID.
itg_bulk_update_configuration_interfacesProWriteBulk-update multiple configuration interfaces in a single request.
itg_bulk_update_configurationsProWriteBulk-update multiple configurations in a single request.
itg_create_configurationProWriteCreate a new configuration (CI).
itg_create_configuration_interfaceProWriteCreate a new interface (IP/MAC/VLAN) for a configuration.
itg_delete_configuration_interfaceProDestructivePermanently delete a configuration interface.
itg_get_configurationFreeRead-onlyRetrieve full details for a single configuration by ID.
itg_get_configuration_interfaceFreeRead-onlyRetrieve full details for a single configuration interface by ID.
itg_list_configuration_interfacesFreeRead-onlyList network interfaces (IPs, VLANs, MAC addresses) for a specific configuration.
itg_list_configurationsFreeRead-onlyList configurations (CIs — servers, workstations, network gear, etc.).
itg_list_domainsFreeRead-onlyList DNS/web domains tracked in IT Glue.
itg_update_configurationProWriteUpdate an existing configuration (PATCH semantics — only provided fields are updated).
itg_update_configuration_interfaceProWriteUpdate an existing configuration interface (PATCH semantics — only provided fields are updated).

[IT Glue] Bulk-delete multiple configurations by ID. Accepts a JSON array of resource objects with {"type":"configurations","id":"<id>"}. This action is destructive and removes the CIs permanently — verify IDs before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"configurations","id":"1"},{"type":"configurations","id":"2"}].

[IT Glue] Bulk-update multiple configuration interfaces in a single request. Accepts a JSON:API data array. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"configuration_interfaces","id":"1","attributes":{"ip_address":"10.0.0.12"}}].

[IT Glue] Bulk-update multiple configurations in a single request. Accepts a JSON:API data array where each element contains {"type":"configurations","id":"<id>","attributes":}. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"configurations","id":"1","attributes":{"hostname":"new-host"}}].

[IT Glue] Create a new configuration (CI). Requires at minimum name, configuration_type_id, and organization_id (either passed in attributes or via the organizationId parameter for nested creation). Returns the created configuration.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with configuration attributes. Example: {"name":"dc01.contoso.local","configuration_type_id":12,"configuration_status_id":3,"hostname":"dc01","primary_ip":"10.0.0.10"}.
organizationIdintegernonullOptional organization ID. When provided, configuration is created nested under that organization (preferred).

[IT Glue] Create a new interface (IP/MAC/VLAN) for a configuration. Requires configuration_id in the attributes. Example: {"configuration_id":123,"name":"eth0","ip_address":"10.0.0.10","mac_address":"aa:bb:cc:dd:ee:ff"}. Returns the created interface.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with interface attributes. Example: {"configuration_id":123,"name":"eth0","ip_address":"10.0.0.10","mac_address":"aa:bb:cc:dd:ee:ff"}.

[IT Glue] Permanently delete a configuration interface. This action cannot be undone.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue configuration interface ID to delete.

[IT Glue] Retrieve full details for a single configuration by ID. Returns the full JSON:API resource object including attributes and relationships (interfaces, location, organization). Use itg_list_configurations to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue configuration ID. Use itg_list_configurations to find valid IDs.

[IT Glue] Retrieve full details for a single configuration interface by ID. Returns the full JSON:API resource object with IP, MAC, VLAN, and related data.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue configuration interface ID. Use itg_list_configuration_interfaces to find valid IDs.

[IT Glue] List network interfaces (IPs, VLANs, MAC addresses) for a specific configuration. Returns paginated JSON:API envelope. Use itg_list_configurations to find valid configuration IDs.

ParamTypeRequiredDefaultDescription
configurationIdintegeryesThe IT Glue configuration ID to list interfaces for. Use itg_list_configurations to find valid IDs.
filterIpAddressstringnonullFilter by IP address.
filterMacAddressstringnonullFilter by MAC address.
filterNamestringnonullFilter by interface name.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] List configurations (CIs — servers, workstations, network gear, etc.). If organizationId is supplied, scopes to that organization; otherwise lists across all organizations. Supports filtering by name, serial_number, asset_tag, configuration_type_id, configuration_status_id, archived. Returns paginated JSON:API envelope.

ParamTypeRequiredDefaultDescription
filterArchivedbooleannonullFilter by archived status. True for archived only, false for active only.
filterAssetTagstringnonullFilter by asset tag.
filterConfigurationStatusIdintegernonullFilter by configuration-status-id. Use itg_list_configuration_statuses to find valid IDs.
filterConfigurationTypeIdintegernonullFilter by configuration-type-id. Use itg_list_configuration_types to find valid IDs.
filterNamestringnonullFilter by configuration name (partial match).
filterSerialNumberstringnonullFilter by serial number.
includeFullMetabooleannofalseWhen true, returns the complete unshaped upstream response (including the meta.filters permitted-value catalogs). Leave false for the leaner default.
organizationIdintegernonullOptional organization ID. When provided, only returns configurations for that organization. Use itg_list_organizations to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] List DNS/web domains tracked in IT Glue. Supports filtering by name, organization_id, registrar_name, expires_on. Returns paginated JSON:API envelope.

ParamTypeRequiredDefaultDescription
filterExpiresOnstringnonullFilter by expiration date (ISO 8601 format, e.g. '2025-12-31').
filterNamestringnonullFilter by domain name (partial match).
filterOrganizationIdintegernonullFilter by organization_id. Use itg_list_organizations to find valid IDs.
filterRegistrarNamestringnonullFilter by registrar name (e.g. 'GoDaddy', 'Cloudflare').
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at, expires_on. Prefix with - for descending.

[IT Glue] Update an existing configuration (PATCH semantics — only provided fields are updated). Returns the updated configuration. Use itg_get_configuration to check current values before updating.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with configuration attributes to update. Example: {"primary_ip":"10.0.0.11","notes":"Migrated to new rack"}.
idintegeryesThe IT Glue configuration ID to update. Use itg_list_configurations to find valid IDs.

[IT Glue] Update an existing configuration interface (PATCH semantics — only provided fields are updated). Returns the updated interface.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with interface attributes to update. Example: {"ip_address":"10.0.0.11","primary":true}.
idintegeryesThe IT Glue configuration interface ID to update.

Passwords & Secrets

ToolPlanAccessSummary
itg_bulk_delete_password_foldersProDestructiveBulk-delete multiple password folders under an organization.
itg_bulk_delete_passwordsProDestructiveBulk-delete multiple passwords by ID.
itg_bulk_update_password_foldersProWriteBulk-update multiple password folders.
itg_bulk_update_passwordsProWriteBulk-update multiple passwords in a single request.
itg_create_passwordProWriteCreate a new password record.
itg_create_password_folderProWriteCreate a new password folder under an organization.
itg_delete_passwordProDestructivePermanently delete a single password.
itg_get_passwordFreeRead-onlyRetrieve full details for a single password by ID, including the plaintext value.
itg_get_password_folderFreeRead-onlyRetrieve full details for a single password folder.
itg_list_password_foldersFreeRead-onlyList password folders for an organization.
itg_list_passwordsFreeRead-onlyList passwords (credentials/secrets).
itg_update_passwordProWriteUpdate an existing password (PATCH semantics — only provided fields are updated).
itg_update_password_folderProWriteUpdate an existing password folder (PATCH semantics — only provided fields are updated).

[IT Glue] Bulk-delete multiple password folders under an organization. Requires API key with Password Access enabled. Deleting a folder removes its structure (but not the passwords themselves unless the API policy cascades). Verify IDs before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"password_folders","id":"1"}].
organizationIdintegeryesThe organization ID the folders belong to.

[IT Glue] Bulk-delete multiple passwords by ID. Requires API key with Password Access enabled. Accepts a JSON array of resource objects with {"type":"passwords","id":"<id>"}. This action is destructive — verify IDs before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"passwords","id":"1"},{"type":"passwords","id":"2"}].

[IT Glue] Bulk-update multiple password folders. Requires API key with Password Access enabled. Accepts a JSON:API data array. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"password_folders","id":"1","attributes":{"name":"New Name"}}].

[IT Glue] Bulk-update multiple passwords in a single request. Requires API key with Password Access enabled. Accepts a JSON:API data array. Optionally pass copilotSmartAssist=true to enable AI-assisted field population. Returns the updated resources.

ParamTypeRequiredDefaultDescription
copilotSmartAssistbooleannonullOptional flag to enable IT Glue Copilot Smart Assist for the bulk update.
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"passwords","id":"1","attributes":{"notes":"Updated"}}].

[IT Glue] Create a new password record. Requires API key with Password Access enabled. Requires at minimum name and password (value), plus organization_id (either in attributes or via the organizationId parameter). Example: {"name":"Admin Portal","username":"admin","password":"s3cret","organization_id":123,"password_category_id":5}. Returns the created password.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with password attributes. Example: {"name":"Admin Portal","username":"admin","password":"s3cret","organization_id":123}.
organizationIdintegernonullOptional organization ID. When provided, password is created nested under that organization (preferred).

[IT Glue] Create a new password folder under an organization. Requires API key with Password Access enabled. Example attributes: {"name":"Network Devices","description":"Router and switch credentials"}. Returns the created folder.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with folder attributes. Example: {"name":"Network Devices","description":"Router creds"}.
organizationIdintegeryesThe organization ID to create the folder under. Use itg_list_organizations to find valid IDs.

[IT Glue] Permanently delete a single password. Requires API key with Password Access enabled. This action cannot be undone — all versions are removed.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue password ID to delete. Use itg_list_passwords to find valid IDs.

[IT Glue] Retrieve full details for a single password by ID, including the plaintext value. Requires API key with Password Access enabled. Optionally pass versionId to retrieve a specific historical version. Use itg_list_passwords to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue password ID. Use itg_list_passwords to find valid IDs.
versionIdintegernonullOptional version ID to fetch a specific historical version of the password.

[IT Glue] Retrieve full details for a single password folder. Requires API key with Password Access enabled. Use itg_list_password_folders to find valid folder IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe password folder ID. Use itg_list_password_folders to find valid IDs.
organizationIdintegeryesThe organization ID the folder belongs to. Use itg_list_organizations to find valid IDs.

[IT Glue] List password folders for an organization. Requires API key with Password Access enabled. Folders organize passwords within an organization's vault. Returns paginated JSON:API envelope.

ParamTypeRequiredDefaultDescription
filterNamestringnonullFilter by folder name (partial match).
organizationIdintegeryesThe organization ID to list password folders for. Use itg_list_organizations to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] List passwords (credentials/secrets). Requires API key with Password Access enabled. Supports filtering by name, organization_id, password_category_id, url, archived. By default the actual secret value is NOT returned — set showPassword=true to include it (only recommended for tools that must fetch the plaintext). Returns paginated JSON:API envelope.

ParamTypeRequiredDefaultDescription
filterArchivedbooleannonullFilter by archived status. True for archived only, false for active only.
filterNamestringnonullFilter by password name (partial match).
filterOrganizationIdintegernonullFilter by organization_id. Use itg_list_organizations to find valid IDs.
filterPasswordCategoryIdintegernonullFilter by password_category_id. Use itg_list_password_categories to find valid IDs.
filterUrlstringnonullFilter by URL (partial match).
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
showPasswordbooleannonullWhen true, the password value is included in the response. Defaults to false (value is redacted server-side).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] Update an existing password (PATCH semantics — only provided fields are updated). Requires API key with Password Access enabled. Updating the 'password' attribute creates a new version. Returns the updated password.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with password attributes to update. Example: {"password":"n3wS3cret","notes":"Rotated on 2026-04-19"}.
idintegeryesThe IT Glue password ID to update. Use itg_list_passwords to find valid IDs.

[IT Glue] Update an existing password folder (PATCH semantics — only provided fields are updated). Requires API key with Password Access enabled. Returns the updated folder.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with folder attributes to update. Example: {"name":"Renamed Folder"}.
idintegeryesThe password folder ID to update.
organizationIdintegeryesThe organization ID the folder belongs to.

Documents & Knowledge

ToolPlanAccessSummary
itg_bulk_delete_documentsProDestructiveBulk-delete multiple documents by ID.
itg_bulk_update_documentsProWriteBulk-update multiple documents in a single request.
itg_create_documentProWriteCreate a new document (KB article).
itg_create_document_sectionProWriteCreate a new section within a document.
itg_delete_document_imageProDestructivePermanently delete a document image.
itg_delete_document_sectionProDestructivePermanently delete a document section.
itg_get_documentFreeRead-onlyRetrieve full details for a single document by ID, including the body content.
itg_get_document_imageFreeRead-onlyRetrieve metadata for a document image by ID.
itg_get_document_sectionFreeRead-onlyRetrieve a single document section by ID.
itg_list_document_foldersFreeRead-onlyList document folders for an organization, so folder IDs become discoverable.
itg_list_document_sectionsFreeRead-onlyList sections of a document.
itg_list_documentsFreeRead-onlyList knowledge-base documents for an organization.
itg_publish_documentProWritePublish a draft document, making it visible in the knowledge base.
itg_update_documentProWriteUpdate an existing document (PATCH semantics — only provided fields are updated).
itg_update_document_sectionProWriteUpdate an existing document section (PATCH semantics — only provided fields are updated).
itg_upload_document_imageProWriteUpload a new image attached to a target document or organization-level gallery.

[IT Glue] Bulk-delete multiple documents by ID. Accepts a JSON array of resource objects with {"type":"documents","id":"<id>"}. This action is destructive — verify IDs before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"documents","id":"1"},{"type":"documents","id":"2"}].

[IT Glue] Bulk-update multiple documents in a single request. Accepts a JSON:API data array. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"documents","id":"1","attributes":{"name":"New Name"}}].

[IT Glue] Create a new document (KB article). Requires at minimum name and organization_id (either in attributes or via the organizationId parameter). The 'content' attribute holds the HTML/markdown body. Returns the created document.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with document attributes. Example: {"name":"Server Room Runbook","content":"<p>Procedures...</p>","organization_id":123,"published":true}.
organizationIdintegernonullOptional organization ID. When provided, document is created nested under that organization (preferred).

[IT Glue] Create a new section within a document. Sections are polymorphic — the `resource-type` discriminator determines the allowed attributes. Per IT Glue's documented schema: `DocumentText` uses `content` (HTML); `DocumentHeading` uses `content` plus integer `level`; `DocumentGallery` takes no type-specific attributes (it is a container populated via image uploads); `DocumentStep` uses `content` with optional `duration` and `reset-count`. Example: {"resource-type":"Document::Text","content":"<p>Instructions...</p>"}.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with section attributes (excluding resource-type, which is passed separately). Text: {"content":"<p>HTML</p>"}. Heading: {"content":"Overview","level":2}. Gallery: (no type-specific attributes). Step: {"content":"<p>Details</p>","duration":60,"reset-count":false}.
documentIdintegeryesThe parent document ID. Use itg_list_documents to find valid IDs.
sectionResourceTypestringyesThe section type discriminator. Must be exactly one of: DocumentText, DocumentHeading, DocumentGallery, DocumentStep.

[IT Glue] Permanently delete a document image. References to the image in document bodies will break. This action cannot be undone.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue document image ID to delete.

[IT Glue] Permanently delete a document section. This action cannot be undone.

ParamTypeRequiredDefaultDescription
documentIdintegeryesThe parent document ID.
idintegeryesThe document section ID to delete.

[IT Glue] Retrieve full details for a single document by ID, including the body content. Returns the full JSON:API resource object. Use itg_list_documents to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue document ID. Use itg_list_documents to find valid IDs.

[IT Glue] Retrieve metadata for a document image by ID. Returns the JSON:API resource describing the uploaded image (URL, filename, size).

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue document image ID.

[IT Glue] Retrieve a single document section by ID. Returns the full JSON:API resource object including section content.

ParamTypeRequiredDefaultDescription
documentIdintegeryesThe parent document ID. Use itg_list_documents to find valid IDs.
idintegeryesThe document section ID. Use itg_list_document_sections to find valid IDs.

[IT Glue] List document folders for an organization, so folder IDs become discoverable. The upstream documents index returns ROOT-LEVEL documents only; anything filed in a folder is invisible to itg_list_documents until you pass its folder ID as filterDocumentFolderId. Returns paginated JSON:API envelope (id, name, parent folder). Use itg_list_organizations to find valid organization IDs.

ParamTypeRequiredDefaultDescription
organizationIdintegeryesThe organization ID to list document folders for. Use itg_list_organizations to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List sections of a document. Sections break a document into ordered, titled chunks of content. Returns paginated JSON:API envelope. Use itg_list_documents to find valid document IDs.

ParamTypeRequiredDefaultDescription
documentIdintegeryesThe document ID whose sections to list. Use itg_list_documents to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, position, created_at, updated_at. Prefix with - for descending.

[IT Glue] List knowledge-base documents for an organization. Returns paginated JSON:API envelope. Supports filtering by name, parent_id, document_folder_id, published. Use itg_list_organizations to find valid organization IDs.

ParamTypeRequiredDefaultDescription
filterDocumentFolderIdintegernonullFilter by document_folder_id.
filterNamestringnonullFilter by document name (partial match).
filterParentIdintegernonullFilter by parent document ID (for child documents under a parent).
filterPublishedbooleannonullFilter by published state. True for published only, false for drafts only.
organizationIdintegeryesThe organization ID to list documents for. Use itg_list_organizations to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] Publish a draft document, making it visible in the knowledge base. Returns the published document state.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue document ID to publish. Use itg_list_documents with filterPublished=false to find draft document IDs.

[IT Glue] Update an existing document (PATCH semantics — only provided fields are updated). Returns the updated document. Use itg_get_document to read current content before updating.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with document attributes to update. Example: {"name":"Updated Runbook","content":"<p>New body</p>"}.
idintegeryesThe IT Glue document ID to update. Use itg_list_documents to find valid IDs.

[IT Glue] Update an existing document section (PATCH semantics — only provided fields are updated). Returns the updated section.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with section attributes to update. Example: {"name":"Renamed Section","content":"<p>Updated</p>"}.
documentIdintegeryesThe parent document ID.
idintegeryesThe document section ID to update.

[IT Glue] Upload a new image attached to a target document or organization-level gallery. IT Glue's JSON:API shape requires a `target` object (type + id) plus an `image` object containing `content` (base64, no data-URL prefix) and `file-name`. Supply the target and image parts as typed parameters below — the tool assembles the JSON:API envelope server-side.

ParamTypeRequiredDefaultDescription
base64ContentstringyesRaw base64-encoded image bytes. Do NOT include a `data:image/...;base64,` prefix — supply only the base64 string itself.
fileNamestringyesThe image file name, including extension (e.g., "diagram.png").
targetIdintegeryesThe ID of the target document or gallery.
targetTypestringyesThe target resource type that owns this image. Must be exactly one of: `document` (attach as an inline image inside a specific document) or `gallery` (organization-level image gallery).

Flexible Assets

ToolPlanAccessSummary
itg_bulk_delete_flexible_assetsProDestructiveBulk-delete multiple flexible asset instances.
itg_bulk_update_flexible_asset_fieldsProWriteBulk-update multiple flexible asset field definitions.
itg_bulk_update_flexible_assetsProDestructiveBulk-update multiple flexible assets in a single request.
itg_create_flexible_assetProWriteCreate a new flexible asset instance.
itg_create_flexible_asset_fieldProWriteCreate a new field on a flexible asset type.
itg_create_flexible_asset_typeProWriteCreate a new flexible asset type (schema).
itg_delete_flexible_assetProDestructivePermanently delete a single flexible asset instance.
itg_delete_flexible_asset_fieldProDestructivePermanently delete a flexible asset field definition.
itg_get_flexible_assetFreeRead-onlyRetrieve a single flexible asset instance by ID, including all traits (custom field values).
itg_get_flexible_asset_fieldFreeRead-onlyRetrieve a single flexible asset field definition by ID.
itg_get_flexible_asset_typeFreeRead-onlyRetrieve a flexible asset type by ID.
itg_list_flexible_asset_fieldsFreeRead-onlyList field definitions for a specific flexible asset type.
itg_list_flexible_asset_typesFreeRead-onlyList flexible asset types (schemas).
itg_list_flexible_assetsFreeRead-onlyList flexible asset instances of a specific type.
itg_update_flexible_assetProDestructiveUpdate an existing flexible asset instance.
itg_update_flexible_asset_fieldProWriteUpdate an existing flexible asset field definition (PATCH semantics — only provided fields are updated).
itg_update_flexible_asset_typeProWriteUpdate an existing flexible asset type (PATCH semantics — only provided fields are updated).

[IT Glue] Bulk-delete multiple flexible asset instances. Accepts a JSON array of resource objects with {"type":"flexible_assets","id":"<id>"}. This action is destructive — verify IDs before running.

ParamTypeRequiredDefaultDescription
idsArrayJsonstringyesJSON array of resource identifiers. Example: [{"type":"flexible_assets","id":"1"},{"type":"flexible_assets","id":"2"}].

[IT Glue] Bulk-update multiple flexible asset field definitions. Accepts a JSON:API data array. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Example: [{"type":"flexible_asset_fields","id":"1","attributes":{"order":10}}].

[IT Glue] Bulk-update multiple flexible assets in a single request. Same destructive-PATCH semantics as itg_update_flexible_asset — include the full traits object in each element. Accepts a JSON:API data array. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of JSON:API resource objects. Each must include the FULL traits object, keyed by each field's name-key from itg_list_flexible_asset_fields (usually hyphenated). Example: [{"type":"flexible_assets","id":"1","attributes":{"traits":{"vendor":"X","expiry-date":"2027-01-01"}}}].

[IT Glue] Create a new flexible asset instance. Requires flexible_asset_type_id, organization_id, and a traits object. Each trait key is that field's name-key exactly as itg_list_flexible_asset_fields returns it, usually lower case with hyphens (e.g. link-type, ip-address-es), and it is sent unchanged; only the top-level keys (flexible_asset_type_id, organization_id) are snake_case. IT Glue answers a wrong trait key with a 422 "Request contains invalid trait keys" that does not say which key, so read the name-keys first. Example: {"flexible_asset_type_id":12,"organization_id":123,"traits":{"expiry-date":"2026-12-31","vendor":"DigiCert"}}. Returns the created asset.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with flexible asset attributes including a 'traits' object. Example: {"flexible_asset_type_id":12,"organization_id":123,"traits":{"vendor":"DigiCert"}}.

[IT Glue] Create a new field on a flexible asset type. The flexibleAssetTypeId is passed explicitly (it is merged into the attributes as `flexible_asset_type_id`). Requires name, kind, and order in the attributes. Example attributes: {"name":"Expiry Date","kind":"Date","order":5,"required":true}. Returns the created field.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with field attributes (excluding flexible_asset_type_id which is passed as a separate parameter). Example: {"name":"Expiry Date","kind":"Date","order":5,"required":true}.
flexibleAssetTypeIdintegeryesThe ID of the flexible asset type that will own this field. Use itg_list_flexible_asset_types to discover IDs.

[IT Glue] Create a new flexible asset type (schema). The attributes must include name, description, icon, and a nested flexible_asset_fields collection defining the field shape. Returns the created type.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with flexible asset type attributes. Example: {"name":"SSL Certificate","description":"Track SSL certs","icon":"lock","enabled":true}.

[IT Glue] Permanently delete a single flexible asset instance. This action cannot be undone.

ParamTypeRequiredDefaultDescription
idintegeryesThe flexible asset ID to delete.

[IT Glue] Permanently delete a flexible asset field definition. This removes the field from ALL instances of the owning asset type and discards stored values — use with caution.

ParamTypeRequiredDefaultDescription
idintegeryesThe flexible asset field ID to delete.

[IT Glue] Retrieve a single flexible asset instance by ID, including all traits (custom field values). Use itg_list_flexible_assets to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe flexible asset ID. Use itg_list_flexible_assets to find valid IDs.

[IT Glue] Retrieve a single flexible asset field definition by ID. Use itg_list_flexible_asset_fields to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe flexible asset field ID.

[IT Glue] Retrieve a flexible asset type by ID. The response does not include the type's field definitions: use itg_list_flexible_asset_fields for those, including each field's name-key, which is what trait keys must match. Use itg_list_flexible_asset_types to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe flexible asset type ID. Use itg_list_flexible_asset_types to find valid IDs.

[IT Glue] List field definitions for a specific flexible asset type. Each field has a kind (Text, Textbox, Number, Select, Tag, etc.) and options. Returns paginated JSON:API envelope. Use itg_list_flexible_asset_types to find valid type IDs.

ParamTypeRequiredDefaultDescription
filterKindstringnonullFilter by kind (e.g. 'Text', 'Textbox', 'Number', 'Select', 'Tag').
filterNamestringnonullFilter by field name (partial match).
flexibleAssetTypeIdintegeryesThe flexible_asset_type_id whose fields to list. Use itg_list_flexible_asset_types to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, order, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] List flexible asset types (schemas). Each type defines a set of custom fields used to describe a category of assets (e.g. 'Active Directory', 'SSL Certificate'). Supports filtering by name, enabled, show_in_menu. Returns paginated JSON:API envelope. Use this to discover type IDs for itg_list_flexible_assets.

ParamTypeRequiredDefaultDescription
filterEnabledbooleannonullFilter by enabled state. True returns only enabled types.
filterNamestringnonullFilter by type name (partial match).
filterShowInMenubooleannonullFilter by whether the type appears in the IT Glue menu.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] List flexible asset instances of a specific type. The flexibleAssetTypeId is REQUIRED by the IT Glue API — the endpoint is scoped to one type at a time. Supports filtering by organization_id, name, and trait values via filter[traits][<trait_name>]=<value>. Returns paginated JSON:API envelope.

ParamTypeRequiredDefaultDescription
filterArchivedbooleannonullFilter by archived state. True for archived only.
filterNamestringnonullFilter by asset name (partial match).
filterOrganizationIdintegernonullFilter by organization_id. Use itg_list_organizations to find valid IDs.
flexibleAssetTypeIdintegeryesREQUIRED: the flexible_asset_type_id to list instances of. Use itg_list_flexible_asset_types to find valid IDs.
pageNumberintegerno1Page number (1-based).
pageSizeintegerno50Results per page (default 50, max 1000).
sortstringnonullSort field. Supports: name, id, created_at, updated_at. Prefix with - for descending.

[IT Glue] Update an existing flexible asset instance. WARNING: PATCH is destructive — any `traits` field omitted from the update will be deleted from the asset. Always pass the full traits object. Use itg_get_flexible_asset first to fetch the current traits, merge your changes, then pass the entire merged object. Returns the updated asset.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with the FULL traits object plus any top-level fields to update. Trait keys are each field's name-key from itg_list_flexible_asset_fields, usually hyphenated. Example: {"traits":{"vendor":"DigiCert","expiry-date":"2027-01-01","notes":"Renewed"}}. Omitted traits WILL BE DELETED.
idintegeryesThe flexible asset ID to update. Use itg_list_flexible_assets to find valid IDs.

[IT Glue] Update an existing flexible asset field definition (PATCH semantics — only provided fields are updated). Returns the updated field.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with field attributes to update. Example: {"name":"Renamed Field","required":false}.
idintegeryesThe flexible asset field ID to update.

[IT Glue] Update an existing flexible asset type (PATCH semantics — only provided fields are updated). Returns the updated type. To modify field definitions, use the flexible asset field tools.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with type attributes to update. Example: {"name":"SSL Cert (Updated)","enabled":false}.
idintegeryesThe flexible asset type ID to update.

Checklists

ToolPlanAccessSummary
itg_bulk_delete_checklistsProDestructivePermanently delete up to 100 checklists in a single call.
itg_bulk_update_checklistsProWriteUpdate up to 100 checklists in a single call.
itg_get_checklistFreeRead-onlyRetrieve full details for a single checklist by ID.
itg_list_checklistsFreeRead-onlyList checklists with optional filters and pagination.
itg_update_checklistProWriteUpdate an existing checklist's attributes.

[IT Glue] Permanently delete up to 100 checklists in a single call. Supply a JSON array of checklist IDs. This action cannot be undone. Returns a JSON:API envelope listing the deleted resources.

ParamTypeRequiredDefaultDescription
idsJsonstringyesJSON array of checklist IDs to delete. Example: [1,2,3].

[IT Glue] Update up to 100 checklists in a single call. Supply a JSON:API `data` array where each entry has `id`, `type`: "checklists", and `attributes`. Returns a JSON:API envelope with the updated resources. Related: itg_update_checklist for single updates.

ParamTypeRequiredDefaultDescription
itemsJsonstringyesJSON array of JSON:API resource objects. Example: [{"id":"1","type":"checklists","attributes":{"name":"Updated"}}].

[IT Glue] Retrieve full details for a single checklist by ID. Returns a JSON:API envelope with the checklist's attributes and relationships. Use itg_list_checklists to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue checklist ID.

[IT Glue] List checklists with optional filters and pagination. If organization_id is provided, results are scoped to that organization (GET /organizations//relationships/checklists); otherwise returns all checklists the API key can see. Returns a JSON:API envelope with `data` array, `links`, and `meta.total-count`. Note: IT Glue does not expose a create-checklist endpoint — new checklists must be created via the web UI. Related: itg_get_checklist, itg_update_checklist.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"Onboarding"}.
organizationIdintegernonullOptional organization ID to scope results. Use itg_list_organizations to find valid IDs.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] Update an existing checklist's attributes. Returns the updated JSON:API envelope. Use itg_get_checklist to inspect current values before updating. Related: itg_bulk_update_checklists for updating many at once.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes` to update. Example: {"name":"Revised name","description":"Updated"}.
idintegeryesThe IT Glue checklist ID to update.
ToolPlanAccessSummary
itg_bulk_delete_attachmentsProDestructivePermanently delete up to 100 attachments from a parent resource in a single call.
itg_bulk_delete_related_itemsProDestructivePermanently delete up to 100 related items from a parent resource in a single call.
itg_create_related_itemProWriteCreate a related item linking the parent resource to another IT Glue resource.
itg_get_attachmentFreeRead-onlyRetrieve a single attachment by ID from a parent resource.
itg_list_attachmentsFreeRead-onlyList attachments for a parent resource.
itg_rename_attachmentProWriteRename an attachment's display name.
itg_update_related_itemProWriteUpdate a related item.
itg_upload_attachmentProWriteUpload a new attachment to a parent resource.

[IT Glue] Permanently delete up to 100 attachments from a parent resource in a single call. This action cannot be undone. Returns a JSON:API envelope listing the deleted resources.

ParamTypeRequiredDefaultDescription
idsJsonstringyesJSON array of attachment IDs to delete. Example: [1,2,3].
resourceIdintegeryesThe parent resource ID.
resourceTypestringyesThe parent resource type. Must be one of: checklists, checklist_templates, configurations, contacts, documents, domains, folders, locations, passwords, ssl_certificates, flexible_assets, tickets.

[IT Glue] Retrieve a single attachment by ID from a parent resource. Returns a JSON:API envelope with attachment metadata (name, content-type, URL). Attachment content itself is referenced via `attachment` URL in the response. Use itg_list_attachments to find IDs.

ParamTypeRequiredDefaultDescription
attachmentIdintegeryesThe attachment ID.
resourceIdintegeryesThe parent resource ID.
resourceTypestringyesThe parent resource type. Must be one of: checklists, checklist_templates, configurations, contacts, documents, domains, folders, locations, passwords, ssl_certificates, flexible_assets, tickets.

[IT Glue] List attachments for a parent resource. Attachments are polymorphic — the same tool works across checklists, configurations, contacts, documents, domains, locations, passwords, ssl_certificates, flexible_assets, and tickets. Returns a JSON:API envelope with `data` and `meta.total-count`. Related: itg_get_attachment, itg_upload_attachment.

ParamTypeRequiredDefaultDescription
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).
resourceIdintegeryesThe parent resource ID (e.g., the configuration ID or document ID).
resourceTypestringyesThe parent resource type. Must be one of: checklists, checklist_templates, configurations, contacts, documents, domains, folders, locations, passwords, ssl_certificates, flexible_assets, tickets.

[IT Glue] Rename an attachment's display name. Rename only — attachment content is immutable. Delete and re-upload to replace the file. Returns the updated JSON:API envelope.

ParamTypeRequiredDefaultDescription
attachmentIdintegeryesThe attachment ID to rename.
namestringyesThe new display name for the attachment.
resourceIdintegeryesThe parent resource ID.
resourceTypestringyesThe parent resource type. Must be one of: checklists, checklist_templates, configurations, contacts, documents, domains, folders, locations, passwords, ssl_certificates, flexible_assets, tickets.

[IT Glue] Upload a new attachment to a parent resource. Provide the file as base64-encoded content. The resourceType must be one of the supported types (checklists, configurations, contacts, documents, domains, locations, passwords, ssl_certificates, flexible_assets, tickets). Returns the created attachment's JSON:API envelope. Files are immutable after upload — use itg_rename_attachment to change the name only.

ParamTypeRequiredDefaultDescription
contentBase64stringyesBase64-encoded file content.
fileNamestringyesThe file name (including extension). Example: "runbook.pdf".
namestringnonullOptional attachment name (defaults to fileName).
resourceIdintegeryesThe parent resource ID.
resourceTypestringyesThe parent resource type. Must be one of: checklists, checklist_templates, configurations, contacts, documents, domains, folders, locations, passwords, ssl_certificates, flexible_assets, tickets.

Discovery & Audit

ToolPlanAccessSummary
itg_get_expirationFreeRead-onlyRetrieve full details for a single expiration event by ID.
itg_list_expirationsFreeRead-onlyList expirations (upcoming and past expiry events across SSL certificates, domains, warranties, and other tracked items).
itg_list_logsFreeRead-onlyList activity/audit logs.
itg_list_user_metricsFreeRead-onlyList per-user activity metrics — logins, view counts, and engagement statistics.

[IT Glue] Retrieve full details for a single expiration event by ID. Returns a JSON:API envelope with the expiration's attributes (resource type, resource ID, expires at, etc.). Use itg_list_expirations to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue expiration ID.

[IT Glue] List expirations (upcoming and past expiry events across SSL certificates, domains, warranties, and other tracked items). Supports filters such as `resource_type`, `expiration_date`, and `organization_id` via JSON-encoded filter map. Returns a JSON:API envelope with `data` and `meta.total-count`. Related: itg_get_expiration.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"resource_type":"SslCertificate","organization_id":"123"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List activity/audit logs. Only the last 30 days of activity are available, and responses are capped at 5 pages regardless of `page[size]`. Supports filters like `user_id`, `action`, and `created_at` via the JSON filter map. Returns a JSON:API envelope with `data` and `meta.total-count`.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"user_id":"42","action":"update"}.
pageNumberintegerno1Page number (1-based, default 1). Capped at 5 pages server-side.
pageSizeintegerno50Results per page (default 50, max 1000). Total results still capped at 5 pages.

[IT Glue] List per-user activity metrics — logins, view counts, and engagement statistics. Supports filters such as `user_id` and date ranges via JSON filter map. Returns a JSON:API envelope with `data` and `meta.total-count`. Useful for adoption reporting and audit.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"user_id":"42"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

Users & Groups

ToolPlanAccessSummary
itg_bulk_update_groupsProWriteUpdate up to 100 groups in a single call.
itg_bulk_update_usersProWriteUpdate up to 100 users in a single call.
itg_create_groupProWriteCreate a new user group.
itg_delete_groupProDestructivePermanently delete a user group by ID.
itg_get_groupFreeRead-onlyRetrieve full details for a single group by ID.
itg_get_userFreeRead-onlyRetrieve full details for a single user by ID.
itg_list_groupsFreeRead-onlyList user groups.
itg_list_usersFreeRead-onlyList directory users.
itg_update_groupProWriteUpdate an existing group's attributes.
itg_update_userProWriteUpdate an existing user's attributes (name, role, MFA settings, etc.).

[IT Glue] Update up to 100 groups in a single call. Supply a JSON:API `data` array where each entry has `id`, `type`: "groups", and `attributes`. Returns a JSON:API envelope with the updated resources.

ParamTypeRequiredDefaultDescription
itemsJsonstringyesJSON array of JSON:API resource objects. Example: [{"id":"1","type":"groups","attributes":{"name":"Renamed"}}].

[IT Glue] Update up to 100 users in a single call. Supply a JSON:API `data` array where each entry has `id`, `type`: "users", and `attributes`. Returns a JSON:API envelope with the updated resources.

ParamTypeRequiredDefaultDescription
itemsJsonstringyesJSON array of JSON:API resource objects. Example: [{"id":"1","type":"users","attributes":{"role-name":"Creator"}}].

[IT Glue] Create a new user group. Supply JSON:API `attributes` (at minimum a `name`). Returns the created JSON:API envelope with the new group's ID.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Helpdesk","description":"Tier 1 support"}.

[IT Glue] Permanently delete a user group by ID. Members are not deleted but lose any group-based permissions. This action cannot be undone.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue group ID to delete.

[IT Glue] Retrieve full details for a single group by ID. Returns a JSON:API envelope with group attributes and related users. Use itg_list_groups to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue group ID.

[IT Glue] Retrieve full details for a single user by ID. Optional `checkAuthorization` flag returns the user's permission set when true. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
checkAuthorizationbooleannonullWhen true, include the user's authorization/permission breakdown in the response.
idintegeryesThe IT Glue user ID.

[IT Glue] List user groups. Groups bundle users for permission assignment. Supports filters such as `name` via JSON filter map. Returns a JSON:API envelope with `data` and `meta.total-count`. Related: itg_get_group, itg_create_group.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"Helpdesk"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List directory users. Supports filters such as `name`, `email`, `role_name` via the JSON filter map. Returns a JSON:API envelope with `data` and `meta.total-count`. IT Glue does not expose user creation or deletion via API — those operations must be performed in the web UI. Related: itg_get_user, itg_update_user.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"email":"admin@example.com"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] Update an existing group's attributes. Returns the updated JSON:API envelope. Use itg_get_group to inspect current values before updating.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes` to update. Example: {"name":"Updated Name"}.
idintegeryesThe IT Glue group ID to update.

[IT Glue] Update an existing user's attributes (name, role, MFA settings, etc.). Returns the updated JSON:API envelope. Use itg_get_user to inspect current values before updating. Related: itg_bulk_update_users for updating many at once.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes` to update. Example: {"first-name":"Jane","role-name":"Administrator"}.
idintegeryesThe IT Glue user ID to update.

Exports

ToolPlanAccessSummary
itg_create_exportProWriteInitiate a new export job.
itg_delete_exportProDestructivePermanently delete an export job and its downloadable artifact.
itg_get_exportFreeRead-onlyRetrieve a single export job by ID.
itg_list_exportsFreeRead-onlyList export jobs.

[IT Glue] Initiate a new export job. Exports are async jobs. After create, poll itg_get_export for completion status. Supply JSON:API `attributes` describing the export scope (e.g., organization_id, resource types). Returns the created export resource with its assigned ID.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"organization-id":123,"resource-types":["configurations","passwords"]}.

[IT Glue] Permanently delete an export job and its downloadable artifact. Exports are async jobs. After create, poll itg_get_export for completion status — deleting removes access to the downloadable data. This action cannot be undone.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue export ID to delete.

[IT Glue] Retrieve a single export job by ID. Exports are async jobs. After create, poll itg_get_export for completion status. When `attributes.status` is `completed`, the download URL is in the response payload. Use itg_list_exports to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue export ID.

[IT Glue] List export jobs. Exports are async jobs. After create, poll itg_get_export for completion status. Supports filters such as `status` via JSON filter map. Returns a JSON:API envelope with `data` and `meta.total-count`.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"status":"completed"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

Reference Data

ToolPlanAccessSummary
itg_bulk_update_modelsProWriteBulk-update multiple models in a single request.
itg_create_configuration_statusProWriteCreate a new configuration status.
itg_create_configuration_typeProWriteCreate a new configuration type.
itg_create_contact_typeProWriteCreate a new contact type.
itg_create_manufacturerProWriteCreate a new manufacturer.
itg_create_modelProWriteCreate a new hardware model.
itg_create_organization_statusProWriteCreate a new organization status.
itg_create_organization_typeProWriteCreate a new organization type.
itg_create_password_categoryProWriteCreate a new password category.
itg_get_configuration_statusFreeRead-onlyRetrieve a single configuration status by ID.
itg_get_configuration_typeFreeRead-onlyRetrieve a single configuration type by ID.
itg_get_contact_typeFreeRead-onlyRetrieve a single contact type by ID.
itg_get_countryFreeRead-onlyRetrieve a single country by ID.
itg_get_manufacturerFreeRead-onlyRetrieve a single manufacturer by ID.
itg_get_modelFreeRead-onlyRetrieve a single model by ID.
itg_get_operating_systemFreeRead-onlyRetrieve a single operating system by ID.
itg_get_organization_statusFreeRead-onlyRetrieve a single organization status by ID.
itg_get_organization_typeFreeRead-onlyRetrieve a single organization type by ID.
itg_get_password_categoryFreeRead-onlyRetrieve a single password category by ID.
itg_get_platformFreeRead-onlyRetrieve a single platform by ID.
itg_get_regionFreeRead-onlyRetrieve a single region by ID.
itg_list_configuration_statusesFreeRead-onlyList configuration statuses (e.g., Active, In Storage, Retired).
itg_list_configuration_typesFreeRead-onlyList configuration types (asset categories such as Desktop, Server, Printer).
itg_list_contact_typesFreeRead-onlyList contact types (e.g., IT Admin, End User, Decision Maker).
itg_list_countriesFreeRead-onlyList reference countries.
itg_list_manufacturersFreeRead-onlyList hardware manufacturers.
itg_list_modelsFreeRead-onlyList hardware models.
itg_list_operating_systemsFreeRead-onlyList operating systems.
itg_list_organization_statusesFreeRead-onlyList organization statuses (e.g., Active, Prospect, Terminated).
itg_list_organization_typesFreeRead-onlyList organization types (e.g., Client, Prospect, Vendor).
itg_list_password_categoriesFreeRead-onlyList password categories (classifications like Admin, Service Account, End User).
itg_list_platformsFreeRead-onlyList platforms (cloud / virtualization hosts like AWS, Azure, VMware).
itg_list_regionsFreeRead-onlyList reference regions (states/provinces).
itg_update_configuration_statusProWriteUpdate an existing configuration status.
itg_update_configuration_typeProWriteUpdate an existing configuration type.
itg_update_contact_typeProWriteUpdate an existing contact type.
itg_update_manufacturerProWriteUpdate an existing manufacturer.
itg_update_modelProWriteUpdate an existing model.
itg_update_organization_statusProWriteUpdate an existing organization status.
itg_update_organization_typeProWriteUpdate an existing organization type.
itg_update_password_categoryProWriteUpdate an existing password category.

[IT Glue] Bulk-update multiple models in a single request. The tool normalizes each element into IT Glue's expected shape server-side, so callers may supply either flat objects ({"id":1,"name":"New"}) or JSON:API resource objects. Returns the updated resources.

ParamTypeRequiredDefaultDescription
dataArrayJsonstringyesJSON array of model updates. Each element must include `id` plus the fields to update. Example: [{"id":1,"name":"ThinkPad X1"},{"id":2,"name":"Latitude 5420"}].

[IT Glue] Create a new configuration status. Supply JSON:API `attributes` with a `name`. Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Decommissioned"}.

[IT Glue] Create a new configuration type. Supply JSON:API `attributes` with a `name`. Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Firewall"}.

[IT Glue] Create a new contact type. Supply JSON:API `attributes` with a `name`. Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Billing Contact"}.

[IT Glue] Create a new manufacturer. Supply JSON:API `attributes` (at minimum a `name`). Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Dell"}.

[IT Glue] Create a new hardware model. Supply JSON:API `attributes` with `name` and the manufacturer relationship. Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"PowerEdge R740","manufacturer-id":1}.

[IT Glue] Create a new organization status. Supply JSON:API `attributes` with a `name`. Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Onboarding"}.

[IT Glue] Create a new organization type. Supply JSON:API `attributes` with a `name`. Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Partner"}.

[IT Glue] Create a new password category. Supply JSON:API `attributes` with a `name`. Returns the created JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Service Account"}.

[IT Glue] Retrieve a single configuration status by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue configuration status ID.

[IT Glue] Retrieve a single configuration type by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue configuration type ID.

[IT Glue] Retrieve a single contact type by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue contact type ID.

[IT Glue] Retrieve a single country by ID. Returns a JSON:API envelope with country attributes (name, ISO codes, etc.). Use itg_list_countries to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue country ID.

[IT Glue] Retrieve a single manufacturer by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue manufacturer ID.

[IT Glue] Retrieve a single model by ID. Returns a JSON:API envelope with model attributes including manufacturer relationship.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue model ID.

[IT Glue] Retrieve a single operating system by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue operating system ID.

[IT Glue] Retrieve a single organization status by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue organization status ID.

[IT Glue] Retrieve a single organization type by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue organization type ID.

[IT Glue] Retrieve a single password category by ID. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue password category ID.

[IT Glue] Retrieve a single platform by ID. Returns a JSON:API envelope. Use itg_list_platforms to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue platform ID.

[IT Glue] Retrieve a single region by ID. Returns a JSON:API envelope with region attributes. Use itg_list_regions to find valid IDs.

ParamTypeRequiredDefaultDescription
idintegeryesThe IT Glue region ID.

[IT Glue] List configuration statuses (e.g., Active, In Storage, Retired). Returns a JSON:API envelope. Supports filters via JSON filter map.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"Active"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List configuration types (asset categories such as Desktop, Server, Printer). Returns a JSON:API envelope. Supports filters via JSON filter map.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"Server"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List contact types (e.g., IT Admin, End User, Decision Maker). Returns a JSON:API envelope. Supports filters via JSON filter map.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List reference countries. Read-only per IT Glue API — country rows are maintained by IT Glue itself. Supports filters such as `name` via JSON filter map. Returns a JSON:API envelope with `data` and `meta.total-count`.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"United States"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List hardware manufacturers. Manufacturers are referenced by Models and Configurations. Supports filters via JSON filter map. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"Dell"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List hardware models. Each model belongs to a manufacturer. Supports filters such as `manufacturer_id`, `name` via JSON filter map. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"manufacturer_id":"1"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List operating systems. Read-only reference data. Supports filters via JSON filter map. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"Windows Server"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List organization statuses (e.g., Active, Prospect, Terminated). Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List organization types (e.g., Client, Prospect, Vendor). Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List password categories (classifications like Admin, Service Account, End User). Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List platforms (cloud / virtualization hosts like AWS, Azure, VMware). Read-only reference data. Supports filters via JSON filter map. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"name":"Azure"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] List reference regions (states/provinces). Read-only per IT Glue API. Supports filters such as `country_id` and `name` via JSON filter map. Returns a JSON:API envelope.

ParamTypeRequiredDefaultDescription
filtersJsonstringnonullOptional JSON object of filter values. Example: {"country_id":"1"}.
pageNumberintegerno1Page number (1-based, default 1).
pageSizeintegerno50Results per page (default 50, max 1000).

[IT Glue] Update an existing configuration status. Returns the updated JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`.
idintegeryesThe IT Glue configuration status ID to update.

[IT Glue] Update an existing configuration type. Returns the updated JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`.
idintegeryesThe IT Glue configuration type ID to update.

[IT Glue] Update an existing contact type. Returns the updated JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`.
idintegeryesThe IT Glue contact type ID to update.

[IT Glue] Update an existing manufacturer. Returns the updated JSON:API envelope. Use itg_get_manufacturer to inspect current values first.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`. Example: {"name":"Dell EMC"}.
idintegeryesThe IT Glue manufacturer ID to update.

[IT Glue] Update an existing model. Returns the updated JSON:API envelope. Related: itg_bulk_update_models for multiple updates.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`.
idintegeryesThe IT Glue model ID to update.

[IT Glue] Update an existing organization status. Returns the updated JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`.
idintegeryesThe IT Glue organization status ID to update.

[IT Glue] Update an existing organization type. Returns the updated JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`.
idintegeryesThe IT Glue organization type ID to update.

[IT Glue] Update an existing password category. Returns the updated JSON:API envelope.

ParamTypeRequiredDefaultDescription
attributesJsonstringyesJSON object with JSON:API `attributes`.
idintegeryesThe IT Glue password category ID to update.