--- sourceDocument: Yokohama API Reference sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/api-reference Release : - yokohama ft:locale : - en-US ft:publication_title : - Yokohama API Reference ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # API reference # API reference {#ariaid-title1} Release version: Yokohama Updated January 30, 2025 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 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 API reference for the Yokohama release (updated January 30, 2025) provides a comprehensive set of APIs to customize and extend the ServiceNow AI Platform. These APIs enable customers to control platform functionality, build new features, and integrate with native mobile apps, web interfaces, server-side logic, and RESTful services. Show full answer Show less ## API Categories and Use Cases * **Client APIs:** Client-side JavaScript APIs allow control over how the ServiceNow AI Platform functions and displays within web browsers. They are commonly used in client scripts and UI policy scripts. For example, GlideAjax enables calling server-side code from client scripts, and GlideForm helps customize forms. * **Client Mobile APIs:** Cabrillo JS is a client-side JavaScript API designed for native mobile applications on the ServiceNow AI Platform. It provides access to native device capabilities, mobile UI elements, and platform-specific mobile functionalities. * **UI Builder APIs:** These APIs support client script development within the UI Builder environment. Client scripts respond to user interactions (like button clicks) or lifecycle events (such as data broker executions), enabling dynamic page behavior. * **Server APIs:** Server-side JavaScript APIs are used to modify existing applications or build new ones. They are invoked from server-side scripts such as business rules and script includes. Scoped APIs target scoped applications (typically new apps), while global APIs serve legacy applications. Common APIs include GlideRecord/GlideQuery for database operations, GlideSystem for instance and user session info, and FlowAPI to trigger workflows. * **REST APIs:** REST APIs provide access to platform data and services. They can be discovered via the REST API Explorer inside the instance and extended with custom Scripted REST APIs if needed. Authentication options include Basic Authentication and OAuth 2.0. Common REST APIs include Attachment API for file uploads, Email API for messaging, and Table API for CRUD operations on records. ## Practical Benefits for ServiceNow Customers * Enable tailored user experiences by customizing UI behavior through client and UI Builder APIs. * Leverage native mobile capabilities for enhanced mobile app functionality using Cabrillo JS. * Automate and extend backend processes with server-side APIs to build scalable, maintainable applications. * Integrate and automate workflows via REST APIs, supporting seamless data exchange and external integrations. * Utilize built-in authentication methods to secure API interactions. Use ServiceNow APIs to change functionalities and add features on the ServiceNow AI Platform. |-|-|-|-|-|-| | [Client Control how the ServiceNow AI Platform functions and is displayed within the web browser.](https://servicenow-prod.fluidtopics.net/q5afiHTjy4_Er70vupCs7Q "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 mobile Build custom mobile experiences inside of ServiceNow AI Platform native mobile apps.](https://servicenow-prod.fluidtopics.net/gokMaqU7Xe4_zT~pGELHnQ "Use Cabrillo JS to build custom mobile experiences inside of ServiceNow AI Platform native mobile apps.") | [UI Builder Build client scripts in UI Builder.](https://servicenow-prod.fluidtopics.net/r9T35_EYkebPLXmOYccQ~Q "Use UI Builder (UIB) APIs in UIB client applications.") | [Server Build and update applications.](https://servicenow-prod.fluidtopics.net/ByMUWtyT~5~2iXRwFAHHDw "Use server APIs in scripts to change the functionality of applications, or when you create new applications.") | [REST Access and update data.](https://servicenow-prod.fluidtopics.net/TAobmkBqHSgcySMDV9MoSw "Use REST interfaces to access data on your instance.") | [Browse APIs by product Find APIs to use with your ServiceNow products.](https://servicenow-prod.fluidtopics.net/12v49fph_0ThkR11QCLgBw "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://servicenow-prod.fluidtopics.net/hQVQpbybRqKr0684okooTQ#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://servicenow-prod.fluidtopics.net/nFxQ1tOqJWjXsNq5seht5A#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. ## 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=yokohama&pubname=yokohama-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. ## 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://servicenow-prod.fluidtopics.net/GNcUDjfFwAF~ZL~iRfwBNQ#c_GlideRecordScopedAPI "The scoped GlideRecord API is used for database operations.") or [GlideQuery](https://servicenow-prod.fluidtopics.net/euBHbdLkSFj_Z6lwicLVMg#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://servicenow-prod.fluidtopics.net/3POZ3ORJskMs37ID0OfLPg#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://servicenow-prod.fluidtopics.net/Lq6Kp9ZEe83E0mZSGo7t~w#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://servicenow-prod.fluidtopics.net/II9UMLEzxwdzNICHcVHP2w#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://servicenow-prod.fluidtopics.net/ktFXRXjLKC7Nmy9NNC3Tew#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://servicenow-prod.fluidtopics.net/tEu_nerQQDnvgoNnC1nCSA#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}