---
sourceDocument: Zurich API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/zurich/api-reference

 Release :

    - zurich

ft:locale :

    - en-US

ft:publication_title :

    - Zurich API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API reference

# API reference {#ariaid-title1}

* Release version: Zurich
* 
* Updated July 31, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read

Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of API reference

The ServiceNow AI Platform provides a comprehensive set of APIs that enable you to customize functionality and extend features across client, mobile, server, REST, and UI Builder environments.
These APIs empower developers to tailor both the user interface and backend processes to meet specific business needs within the ServiceNow Zurich release.
Show full answer Show less  

## Client APIs

Client-side JavaScript APIs control how the ServiceNow AI Platform functions and displays in web browsers. They are used in client scripts and UI policy scripts to enhance user experiences. Common practical uses include:

* Calling server-side code via GlideAjax from client scripts.
* Customizing forms using the GlideForm API.

For the Next Experience UI Framework, client APIs provide similar capabilities tailored to the modern UI.

## Mobile APIs and SDK

ServiceNow supports mobile customization through two main options:

* **Client mobile (Cabrillo JS):** JavaScript APIs for native mobile apps to access device capabilities and native UI features.
* **Mobile SDK:** Enables building standalone Android and iOS applications that integrate deeply with ServiceNow. Key features include:

<!-- -->

* Accessing instance data through REST APIs.
* Embedding Virtual Agent and NowVoice, an AI-powered voice interface with real-time transcripts and controls.
* Tracking custom analytics events.
* Attaching documents to records.
* Loading ServiceNow-hosted web pages within native views.
* Implementing authentication flows using JSON Web Tokens.
* Sending push notifications.

## Server APIs

Server-side JavaScript APIs enable building or enhancing applications with backend logic. These APIs are used in business rules, script includes, and other server scripts. They come in scoped and global varieties depending on the application scope. Key capabilities include:

* Performing CRUD operations on records using GlideRecord or GlideQuery.
* Accessing instance and session information with GlideSystem.
* Triggering flows and actions via FlowAPI methods.

## REST APIs

REST APIs provide standardized access to data and services on the ServiceNow AI Platform. You can discover existing APIs via the REST API Explorer or create custom ones using Scripted REST APIs. Authentication supports Basic Auth and OAuth 2.0. Common uses include:

* Uploading and querying attachments.
* Sending and receiving emails.
* CRUD operations on table records.

## UI Builder APIs

UI Builder APIs facilitate client scripting within the UI Builder environment. They respond to user interactions (e.g., button clicks) and lifecycle events (e.g., data broker executions) to provide dynamic page behavior.

## Practical Benefits

By leveraging these APIs, ServiceNow customers can customize user interfaces, automate backend processes, integrate mobile experiences, and extend their platform capabilities efficiently and securely. This flexibility supports building tailored solutions that enhance productivity and user engagement on the ServiceNow AI Platform.  
Use ServiceNow APIs to change functionality and add features on the ServiceNow AI Platform.

|-|-|-|-|
| [Client Control how the ServiceNow AI Platform functions and is displayed within the web browser.](https://www.servicenow.com/docs/wQoQnnIKXJOfivEvgkSSVA "Use client-side JavaScript APIs to control aspects of how ServiceNow AI Platform is displayed and functions within the web browser. This reference lists available classes and methods along with parameters, descriptions, and examples to help control the end-user experience.") | [Client Next Experience Control how the ServiceNow AI Platform functions and is displayed within the web browser in the Next Experience UI Framework.](https://www.servicenow.com/docs/nM8PZxYQT0FzJbSnZ3JuIw "This reference contains Glide client-side JavaScript APIs with options and compatibility in Configurable Workspace in the Next Experience UI. You can use the classes and methods along with parameters, descriptions, and examples to help control the end-user experience.") | [Client mobile Build custom mobile experiences inside of ServiceNow AI Platform native mobile apps.](https://www.servicenow.com/docs/4QjkO9EDoVoXGJuXY~WRbg "Use Cabrillo JS to build custom mobile experiences inside of ServiceNow AI Platform native mobile apps.") | [Mobile SDK Leverage the ServiceNow AI Platform within standalone Android and iOS apps.](https://www.servicenow.com/docs/VHiLH807euRJN~hhadURZw "Use the ServiceNow Mobile SDK to leverage the functionality and resources of the ServiceNow platform within your standalone mobile Android and iOS applications.") |
| [Server Build and update applications.](https://www.servicenow.com/docs/uieOz3tI3SKtP_eSQdDMCQ "Use server APIs in scripts to change the functionality of applications, or when you create new applications.") | [REST Access and update data.](https://www.servicenow.com/docs/lZDRBycaJbJxtNqK14UUfA "Use REST interfaces to access data on your instance.") | [UI Builder Build client scripts in UI Builder.](https://www.servicenow.com/docs/pEGhJJplvB_ukC3u4_JXUQ "Use UI Builder (UIB) APIs in UIB client applications.") | [Browse APIs by product Find APIs to use with your ServiceNow products.](https://www.servicenow.com/docs/qEoNPCf_04W6TYtlo9nlPg "Find APIs to use with your ServiceNow products.") |
[ ]

{#api-reference__table_iwv_lpv_klb}

## Client {#api-reference__section_ynk_qy4_vvb}

Use client-side JavaScript APIs to control how the ServiceNow AI Platform functions and displays within the web browser. Client-side APIs provide common functionality that you can add to your instance by calling the APIs from client-side scripts such as client scripts and UI
policy scripts.  
Common use cases:

* Use the [GlideAjax](https://www.servicenow.com/docs/OJUmbYDsbf4D8KO28Ph3cg#c_GlideAjaxAPI "The GlideAjax class enables a client script to call server-side code in a script include.") API to call server-side code from a client script.
* Use the [GlideForm](https://www.servicenow.com/docs/GBSWDU7QxyXO8Zmb5zMf2w#c_GlideFormAPI "The GlideForm API provides methods to customize forms.") API to customize forms.
{#api-reference__ul_ibs_kbk_fwb}

## Client mobile {#api-reference__section_ug3_ckz_5wb}

Cabrillo JS is a client-side JavaScript API for accessing capabilities inside ServiceNow AI Platform native mobile applications. Cabrillo JS provides methods to use native device capabilities, native mobile UI, and other ServiceNow AI Platform mobile functionality.

## Mobile SDK {#api-reference__section_k2h_fwp_dyb}

Use the ServiceNow
Mobile SDK to leverage the functionality and resources of the ServiceNow AI Platform within your standalone mobile Android and iOS applications.

Using the Mobile SDK, you can perform the following within your applications:  
* Access data on your ServiceNow instance through its public REST APIs or custom scripted REST APIs that you develop.
* Embed and enable Virtual Agent within your application interface.
* Embed a real-time, AI-powered voice agent directly in your mobile application. NowVoice provides a full-screen voice interface with live transcripts, mute controls, and post-call transcript sharing.
* Gather and track custom analytics events for analysis.
* Attach documents (attachments) to a record within your ServiceNow instance.
* Load web pages hosted on your ServiceNow instance in a native web view or Cabrillo.
* Provide simple authentication flows using JSON Web Tokens for third-party applications to authenticate users.
* Send push notifications.

## Server {#api-reference__section_zz5_qy4_vvb}

Use server-side JavaScript APIs to change the functionality of existing applications or to
build new applications. Server-side APIs provide common functionality that you can add to
your instance by calling the APIs from server-side scripts such as business rules and script
includes. Scoped APIs are intended for use with scoped applications, and global APIs are
intended for use with applications in the global scope. New applications are typically
scoped. Applications in the global scope are typically legacy applications.  
Common use cases:

* Use the [GlideRecord](https://www.servicenow.com/docs/XnhzR4LTwK_VVBTm5Iii4g#c_GlideRecordScopedAPI "The scoped GlideRecord API is used for database operations.") or [GlideQuery](https://www.servicenow.com/docs/zTF54acHaiNEOuN28cn_9A#GlideQueryGlobalAPI "The GlideQuery script include is an alternative to the GlideRecord API for performing CRUD operations on record data from server-side scripts.") APIs to perform create, read, update, and delete operations on record data from server-side scripts.
* Use the [GlideSystem](https://www.servicenow.com/docs/e5jiJ75qX9PSpmBkiDPoTg#c_GlideSystemScopedAPI "The scoped GlideSystem API provides a number of convenient methods to obtain information about the system, the current logged in user, and other system level information.") API to access information about the instance or the current user session and to write informational or error messages.
* Use [FlowAPI](https://www.servicenow.com/docs/ncH214V8q3eKEn66qgGDhQ#ScriptableFlowAPI "The FlowAPI provides methods to execute actions, flows, or subflows in server-side scripts using either blocking or non-blocking methods.") methods to trigger flows, subflows, and actions from server-side scripts.
{#api-reference__ul_tsd_kbk_fwb}

## REST {#api-reference__section_ifh_ry4_vvb}

Use REST APIs to access and update data on the ServiceNow AI Platform. You can discover
these APIs from within your instance by using the REST API Explorer. If you don't find an
API that meets your needs, you can create custom REST APIs using the Scripted REST API
feature. ServiceNow REST APIs support Basic Authentication and OAuth
2.0 to authenticate requests.  
Common use cases:

* Use the [Attachment API](https://www.servicenow.com/docs/lfpHTMPdNaq_xdajhuTwEg#c_AttachmentAPI "The Attachment API provides endpoints that allow you to upload and query file attachments.") to upload and query file attachments.
* Use the [Email
  API](https://www.servicenow.com/docs/z3cWbwyGNEViOyr9_h4M_Q#email-api "The Email API provides endpoints that enable you to receive and send email messages using REST.") to send and receive email messages.
* Use the [Table
  API](https://www.servicenow.com/docs/sIehVLrQON4zvkIDTxVDQg#c_TableAPI "The Table API provides endpoints that allow you to perform create, read, update, and delete (CRUD) operations on existing tables.") to create, read, update, and delete records in a table.
{#api-reference__ul_nhb_nh2_bwb}

## UI Builder {#api-reference__section_g1j_4tj_dxb}

Use UI Builder APIs when developing client scripts in the [UI Builder](https://www.servicenow.com/docs/access?context=ui-builder-overview&version=zurich&pubname=zurich-application-development&ft:locale=en-US). Client scripts are executed in response to something happening on a page, such as:

* User interaction events/actions, such as a button click.
* Lifecycle events, such as a data broker execution started.
{#api-reference__ul_d2t_hbv_bgc}