API reference

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 minutes to read
    • Summarize
    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

    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 API to call server-side code from a client script.
    • Use the GlideForm API to customize forms.

    Client mobile

    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

    Use UI Builder APIs when developing client scripts in the UI Builder. 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

    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 or GlideQuery APIs to perform create, read, update, and delete operations on record data from server-side scripts.
    • Use the GlideSystem API to access information about the instance or the current user session and to write informational or error messages.
    • Use FlowAPI methods to trigger flows, subflows, and actions from server-side scripts.

    REST

    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 to upload and query file attachments.
    • Use the Email API to send and receive email messages.
    • Use the Table API to create, read, update, and delete records in a table.