REST API reference

Use REST interfaces to access data on your instance.

• Account API
  The Account API provides endpoints to retrieve Customer Service Management (CSM) account records.
• ActivitySubscriptions API
  The ActivitySubscriptions API provides endpoints to retrieve Activity entities from the Subscriptions and Activity Feed Framework.
• Agent Client Collector API
  The Agent Client Collector API provides endpoints to manage actions on available agents and managing policies.
• Agent Mapping API
  The Agent Mapping API provides an endpoint to map external agent IDs from Contact Center as a Service (CCaaS) systems to internal agent IDs in the ServiceNow AI Platform.
• Aggregate API
  The Aggregate API provides endpoints that allow you to compute aggregate statistics about existing table and column data.
• AI Assets API
  AI Assets API provides endpoints to retrieve, update, and create several types of AI assets, such as systems, data sets, prompts, and models.
• AI Search External User Mapping API
  The AI Search External User Mapping API provides endpoints that enable ingestion of user mapping information from external sources into the ServiceNow® AI Search application's index.
• Alarm Management Open API
  The Alarm Management Open API provides endpoints to create, update, and retrieve data from the Events [em_event] and Alert [em_alert] tables.
• AP Invoice API
  Allows external systems, such as those used by vendors, to securely submit invoices directly into an accounts payable system in a structured and automated manner.
• Application Service API
  The Application Service API provides endpoints that enable you to create, modify, and update application services.
• Appointment API
  The Appointment API provides endpoints for interacting with the appointment booking application. Use this API to book and reschedule appointments, check available appointment slots, and fetch appointment booking configuration details.
• Appointment Open API
  The Appointment Open API is a telecommunication API that allows you to interact with the appointment booking application. Use this API to book appointments and search available time slots.
• ATF Code Coverage API
  The ATF Code Coverage API provides endpoints to compute code coverage from Automated Test Framework (ATF) runs. Coverage can be retrieved by filtered line numbers, for specific script IDs, or for all scripts covered by a set of test suite/test runs.
• Attachment API
  The Attachment API provides endpoints that allow you to upload and query file attachments.
• Automation Center API
  The Automation Center API provides endpoints to create and update data related to robots, processes, and execution jobs. By leveraging this API, you can integrate and reflect details from your automation workflows into the Automation Center dashboard.
• AWA Agent API
  The AWA (Advanced Work Assignment) Agent API provides endpoints to manage agent presence, channel availability, and workload.
• AWA Agent Consult API
  Handles agent consult work items.
• AWA Inbox Actions API
  The AWA Inbox Actions API provides endpoints to accept or reject a work item on behalf of an agent. This API also retrieves reject reasons for rejected work items.
• AWA Manual Assignment API
  The AWA Manual Assignment API provides an endpoint to manually assign available work items to available Advanced Work Assignment (AWA) agents.
• AWA Offer Work API
  The AWA Offer Work API provides an endpoint to assign or transfer work items to agents.
• AWA Routing API
  The AWA Routing API provides endpoints to route a document to a queue.
• Batch API
  The Batch API provides endpoints to send a single request containing multiple REST API calls, and returns a stream of response payloads.
• Case API
  The Case API provides endpoints that enable you to retrieve and update Customer Service Management (CSM) case records.
• CCCIF Media Resource API
  The Custom Chat Chatbot Interoperability Framework (CCCIF) Media Resource API provides endpoints that enable a primary bot to upload attachments to the associated ServiceNow instance.
• CdmApplicationsApi
  The CdmApplicationsApi provides endpoints that enable you to uploadzoominsoftware.io/utah-devops/ configuration data to the component, collection, deployable, and component variable folders found in the DevOps Config Workspace UI. It also has endpoints that enable you to export deployable configuration data to your DevOps pipeline and manage shared components and shared applications.
• CdmChangesetsApi
  The CdmChangesetsApi provides endpoints that enable you to manage changesets.
• CdmEditorApi
  The CdmEditorApi provides endpoints that enable you to create nodes, update nodes, include existing nodes under other nodes, delete nodes, and retrieve nodes and node includes.
• CdmPoliciesApi
  The CdmPoliciesApi provides endpoints that enable you to manage policy mappings of deployables in Configuration Data Management (CDM). Policies that are properly mapped to a deployable are executed when a snapshot of the deployable is validated.
• CdmSharedLibraryApi
  The CdmSharedLibraryApi provides endpoints that enable you to create and manage shared libraries and shared components. It also has endpoints that enable you to upload and export the configuration data of a shared component.
• CdmSnapshotApi
  The CdmSnapshotApi provides endpoints that enable you to publish, unpublish, and re-validate snapshots in Configuration Data Management (CDM).
• CdmVersionApi
  The CdmVersionApi provides endpoints that enable you to publish, unpublish, and export versions (snapshots) in Configuration Data Management (CDM) for shared components under shared libraries.
• Change Management API
  The Change Management API provides endpoints that enable third-party application integration with the ServiceNow Change Management process.
• CI Lifecycle Management API
  The CI Lifecycle Management API provides endpoints to manipulate configuration item (CI) operational states and apply CI actions.
• Cloud Runner Test Generation REST API
  Manages test job generation to be executed in a cloud runner for Automated Test Framework (ATF).
• Cloud Runner Test Runner REST API
  Manages tests to be executed in a cloud runner for Automated Test Framework (ATF).
• Cloud Runner Test User REST API
  Manages test user jobs to be executed in a cloud runner for Automated Test Framework (ATF).
• Cloud Services Catalog API
  The Cloud Services Catalog API provides methods related to Day-1 (provisioning) and Day-2 (modification) operations available in the Cloud Services Catalog, such as creating cloud service stacks and calling resource operation requests. You can also retrieve information about catalog requests, stacks getting status, and other information.
• CMDB Data Ingestion API
  The CMDB Data Ingestion API provides endpoints that enable the batch ingestion of an array of objects into an Import Set table.
• CMDB Instance API
  The CMDB Instance API provides endpoints to create, read, update, and delete operations on existing Configuration Management Database (CMDB) tables. You can only insert, update, or delete one record at a time.
• CMDB Meta API
  The CMDB Meta API provides endpoints to obtain meta data on a Configuration Management Database (CMDB) class.
• Consumer API
  The Consumer API provides endpoints to retrieve and update Customer Service Management (CSM) consumer records.
• Contact API
  The Contact API provides endpoints that enable you to retrieve and update Customer Service Management (CSM) contact records.
• Continuous Integration/Continuous Delivery (CICD) API
  The CICD API provides endpoints that enable integration with common DevOps tools for building pipelines. These tools include Jenkins, Azure Pipelines, GitLab, GitHub Actions, Atlassian Bamboo/Pipelines, and more.
• Continuous Integration and Continuous Delivery (CICD) Update Set API
  The CICD Update Set API provides methods to create, retrieve, preview, commit, and back-out an update set.
• Conversation Member API
  The Conversation Member API provides methods for changing a specific agent’s member state to removed or updated in a given Agent Chat conversation.
• CSM Attachment API
  The CSM Attachment API provides endpoints that allow both internal and external users to upload, download, and remove attachments associated with a table and to retrieve attachment metadata.
• CTI API
  The CTI API provides endpoints that enable Computer Telephony Integration (CTI) providers to interact with the Cloud Call Center framework.
• Customer Central API
  The Customer Central API provides endpoints to access customer information and configuration details.
• Data Classification API
  The Data Classification API provides endpoints to group data by type.
• DCIM Metric Data Feed API
  The DCIM Metric Data Feed API provides an endpoint to accept Data Center Infrastructure Management (DCIM) metric data from an external system and store the data in a MetricBase database.
• DevOps API
  The DevOps API provides endpoints that enable the interaction with external DevOps tools.
• DevOps Config API
  The DevOps Config API provides endpoints to manage your applications.
• Digital Product Release API
  The Digital Product Release API provides endpoints to manage releases and policy compliance.
• Email API
  The Email API provides endpoints that enable you to receive and send email messages using REST.
• Entitlement API
  The Entitlement API provides endpoints to create and retrieve entitlement records from an instance.
• Event Management Topic Open API
  The Event Management Topic Open API provides an endpoint that enables you to send a topic through your message broker and store it on a ServiceNow instance.
• Event Notification Management Open API
  The Event Notification Management Open API provides an endpoint to create, update, and delete events from the Events [em_event] table.
• External Content Ingestion API
  The External Content Ingestion API provides endpoints that enable ingestion of content from sources outside of your ServiceNow® instance into the ServiceNow® AI Search application's index.
• External ID Mapping API
  Enables external Contact Center as a Service (CCaaS) platforms to store and retrieve routing identifiers for ServiceNow records.
• Help Request API
  The Help Request API provides an endpoint to track supervisor help actions.
• HR REST API
  The HR REST API provides endpoints that return information about employees that work or live in the United States.
• Identification and Reconciliation API
  The Identification and Reconciliation API provides endpoints that use the Identification and Reconciliation engine (IRE) to minimize creation of duplicate Configuration Items (CIs) and to reconcile CI attributes by only accepting information from authorized sources when updating the Configuration Management Database (CMDB).
• Import Set API
  The Import Set API provides endpoints that allow you to interact with import set tables.
• Install Base Item API
  The Install Base Item API provides endpoints to access and manage install base items records within a ServiceNow instance.
• Interaction Management API
  The Interaction Management API provides endpoints to create interactions.
• Knowledge Management REST API
  The Knowledge Management API provides endpoints for searching, viewing, and fetching lists of the most-viewed and featured knowledge articles.
• lead API
  The lead API provides endpoints that enable you to create, update, and query/retrieve marketing leads and their associated lead line items from an instance.
• MetricBase Time Series API
  The MetricBase Time Series API provides endpoints to insert data into, retrieve information from, and to run transforms against a MetricBase database.
• Omichannel Callback API
  The Omnichannel Callback API provides methods for creating, updating, and initiating a callback request for live agent conversations.
• openframe API
  The openframe API provides endpoints that provide Contact Center as a Service (CCaaS) the ability to create and update interaction records without using the Operation Handler.
• Order API
  The Order API provides endpoints for retrieving and creating orders with order line items for the Customer Service Management application.
• Party Management Open API
  The Party Management Open API provides endpoints for managing parties with a relationship to the enterprise, like a consumer, account, or contact. Use this API to create, update, and retrieve data from the Consumer [csm_consumer], Account [customer_account], and Contact [customer_contact] tables.
• Predictive Intelligence API
  The Predictive Intelligence API provides endpoints that predict a field value based on one or more input fields and a trained solution.
• Proactive Engagement API
  The Proactive Engagement API provides an endpoint for creating digital experience issues.
• Product Catalog Open API
  The Product Catalog Open API provides endpoints to create and retrieve product catalogs, product offerings, and product specifications.
• Product Inventory Open API
  The Product Inventory Open API provides endpoints to create and retrieve product inventories.
• Product Order Open API
  The Product Order Open API provides endpoints that enable a standardized mechanism for placing product orders.
• Project Portfolio Management API
  The Project Portfolio Management API provides endpoints to bulk import cost plans and project tasks.
• Push Installation API
  The Push Installation API provides endpoints to register and unregister the tokens that enable mobile devices to receive push notifications from an application.
• Push Metrics API
  The Push Metrics API provides endpoints that enable you to push raw Metric Intelligence data from an external source to the MID Server.
• Quote Management API
  The Quote Management API provides endpoints to create, update, and retrieve customer quote data.
• Remote help request API
  The Remote help request API provides endpoints to create, view, and fetch lists of IT service requests and their details from an electronic medical record (EMR) system. An IT service request is associated with a task type such as an incident in the ServiceNow instance.
• Resource Inventory Open API
  The Resource Inventory Open API provides endpoints to create, retrieve, and delete resources.
• Response Templates API
  The Response Templates API provides endpoints to handle records in the Response Templates [sn_templated_snip_note_template] table.
• Sales Agreement API
  The Sales Agreement API provides methods for creating a new sales agreement and retrieving an existing sales agreement of a given sys_id.
• SAM-Software Usage Data Integration API
  The SAM-Software Usage Data Integration API provides endpoints to create and update records in the Software Usage [samp_sw_usage] table.
• Scorecards API
  The Scorecards API provides endpoints that enable you to query data about Performance Analytics indicators. The query parameters equate to the functions available on the Analytics Hub for drilling down into an indicator.
• Script Debugger API
  The Script Debugger API provides endpoints to debug lines of server-side JavaScript code, such as business rules and script includes.
• Service Catalog API
  The Service Catalog API provides endpoints that access Service Catalog configuration and actions from within a Service Portal.
• Service Catalog Open API
  The Service Catalog Open API provides endpoints to create and retrieve service specifications.
• Service Contract API
  The Service Contract API provides endpoints to create and retrieve service contract records.
• Service Order Open API
  The Service Order Open API provides endpoints that enable a standardized mechanism for placing service orders.
• Service Test Management Open API
  The Service Test Management Open API provides endpoints to create and retrieve service test definitions and service tests.
• SG Services API
  The SG Services API provides endpoints to create and manage application services and the upstream relationships between them.
• Spendint API
  The Spendint API provides endpoints that push the catalog, price, availability, order, shipment, and invoice information from a third party to the ServiceNow instance. This API is part of the Source-to-Pay Integration Framework application.
• System for Cross-domain Identity Management (SCIM) API
  The System for Cross-domain Identity Management (SCIM) API provides endpoints to create, read, update, and delete operations on users and groups using the SCIM protocol.
• Table API
  The Table API provides endpoints that allow you to perform create, read, update, and delete (CRUD) operations on existing tables.
• Technical Service Qualification Open API
  The Technical Service Qualification Open API provides endpoints to check the availability of resources and services before submitting orders for fulfillment.
• TISC API
  The TISC API provides endpoints to add and retrieve threat intelligence data in the Threat Intelligence Security Center (TISC) application.
• TISC Intel Exchange API
  Enables external systems to share threat intelligence data with the Threat Intelligence Security Center (TISC) application.
• TISC RPZ API
  The TISC RPZ API provides an endpoint to export domains and IP addresses in Response Policy Zone (RPZ) format.
• TISC TAXII Server API
  Provides Trusted Automated Exchange of Intelligence Information (TAXII) server endpoints for sharing threat intelligence data in Threat Intelligence Security Center (TISC).
• Trouble Ticket Open API
  The Trouble Ticket Open API provides endpoints to create, update, and retrieve data from the Case [sn_customerservice_case], Incident [incident], and Service Problem Case [sn_sprb_mgmt_case] tables.
• User Role Inheritance API
  The User Role Inheritance API provides endpoints that allow you to see the roles that a specific user inherited.
• Verify Entitlements API
  The Verify Entitlements API provides endpoints that enable you to obtain a list of valid entitlements, details about the characteristics of entitlements, and an entitlement's latest usage information.
• Virtual Agent Bot Integration API
  The Virtual Agent Bot Integration API provides endpoints that allow users to integrate any chat interface or a bot ecosystem with the ServiceNow Virtual Agent and/or Live Agent.
• Voice Interaction Resource API
  The Voice Interaction API provides endpoints to transcribe and store voice interactions between agents and callers during a telephone conversation. It works in conjunction with Virtual Agent and Live Agent chats.
• Work Order Management API
  The Work Order Management API provides endpoints to create, update, and retrieve work orders.
• Workplace Connector Webhook API
  The Workplace Connector Webhook API is a generic interface that enables data from different kinds of workplace hardware or sensors (such as badging systems or occupancy sensors) to be stored in Workplace Service Delivery tables.
• Wrap Up API
  The Wrap Up API provides endpoints for managing wrap-up functionality for external Contact Center as a Service (CCaaS) systems or ServiceNow AI Platform workspaces.
• WSD Extra Service API
  The Workplace Service Delivery (WSD) Extra Service API provides endpoints to retrieve extra services, such as location layouts and standard services of a workplace location.
• WSD Extra Service Request API
  The Workplace Service Delivery (WSD) Extra Service Request API provides endpoints to manage extra service requests for reservations.
• WSD Group Reservation API
  The Workplace Service Delivery (WSD) Group Reservation API provides endpoints for managing group reservations.
• WSD Multi Reservation API
  The Workplace Service Delivery (WSD) Multi Reservation API provides endpoints for managing reservations with multiple workplace locations.
• WSD Recurring Reservation API
  The Workplace Service Delivery (WSD) Recurring Reservation API provides endpoints for managing reservations that occur at the same time, but have different dates.
• WSD Reservable API
  The Workplace Service Delivery (WSD) Reservable API provides endpoints to retrieve details of a reservable, an entity that can be reserved, such as a workplace location, from a ServiceNow instance.
• WSD Reservable V2 API
  The Workplace Service Delivery (WSD) Reservable V2 API provides endpoints to retrieve details of a reservable, an entity that can be reserved, such as a workplace location, from a ServiceNow instance.
• WSD Reservable Module API
  The Workplace Service Delivery (WSD) Reservable Module API provides endpoints to retrieve details of a reservable module from a ServiceNow instance.
• WSD Reservation API
  The Workplace Service Delivery (WSD) Reservation API provides endpoints for managing workplace reservations.
• WSD Reservation Invitees API
  The Workplace Service Delivery (WSD) Reservation Invitees API provides endpoints to add invitees to reservations, fetch invitees of a reservation, and reassign invitees of a reservation.
• WSD Search API
  The Workplace Service Delivery (WSD) Search API provides endpoints to search for available locations and workplace items such as reservables, reservable modules, and available shifts.
• WSD Shift API
  The Workplace Service Delivery (WSD) Shift API provides an endpoint that returns shift time spans for a specified date and time.