Table of Contents
ServiceNow allows employees to work the way they want to, not how software dictates they have to. And customers can get what they need, when they need it.
API Overview
ServiceNow is a cloud-based platform that provides a comprehensive suite of services for IT service management (ITSM), customer service management (CSM), and other enterprise applications. It offers a wide range of capabilities, including incident management, problem management, change management, service catalog management, knowledge management, and asset management. ServiceNow's platform is designed to be highly customizable and scalable, allowing organizations to tailor it to their specific needs. Additionally, ServiceNow provides a marketplace of pre-built applications and integrations that can extend the platform's functionality.
ServiceNow's API overview provides comprehensive documentation for developers to interact with the platform. The REST APIs offer a flexible and efficient way to access and manipulate data, enabling seamless integration with external systems. Webhooks allow for real-time notifications of events, facilitating automated workflows and ensuring timely responses. To ensure optimal performance and prevent abuse, ServiceNow implements rate limits to regulate API usage. By adhering to these limits, developers can maintain a consistent and reliable experience for all users.
APIs
Method: GET
Description: Retrieves a list of Action Guides matching the query criteria. Action Guides are predefined procedures that serve as a recipe or visual workflow to achieve a specific goal..
Endpoint: action_guides
Parameters: sysparm_query
Method: GET
Description: Retrieves an Action Guide..
Endpoint: action_guides/{action_guide}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Action Guide Definitions matching the query criteria. Action Guide Definitions are used to define the definition of an Action Guide..
Endpoint: action_guide_definitions
Parameters: sysparm_query
Method: GET
Description: Retrieves an Action Guide Definition..
Endpoint: action_guide_definitions/{action_guide_definition}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Activities matching the query criteria. Activities represent work items in ServiceNow. They are used to track and manage tasks.
Endpoint: issues
Parameters: and other types of work.
Method: GET
Description: Retrieves an Activity..
Endpoint: activities/{activity}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Approvals matching the query criteria. Approvals are used to request and track approvals for various types of requests..
Endpoint: approvals
Parameters: sysparm_query
Method: GET
Description: Retrieves an Approval..
Endpoint: approvals/{approval}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Attachments matching the query criteria. Attachments are files that are attached to records..
Endpoint: attachments
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Audit Logs matching the query criteria. Audit Logs track changes made to records in ServiceNow..
Endpoint: audit_logs
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Business Rules matching the query criteria. Business Rules are used to automate and enforce business logic in ServiceNow..
Endpoint: business_rules
Parameters: sysparm_query
Method: GET
Description: Retrieves a Business Rule..
Endpoint: business_rules/{business_rule}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Calendar Events matching the query criteria. Calendar Events represent scheduled events in ServiceNow..
Endpoint: calendar_events
Parameters: sysparm_query
Method: GET
Description: Retrieves a Calendar Event..
Endpoint: calendar_events/{calendar_event}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Catalog Items matching the query criteria. Catalog Items are used to request and provision services and products from a Service Catalog..
Endpoint: catalog_items
Parameters: sysparm_query
Method: GET
Description: Retrieves a Catalog Item..
Endpoint: catalog_items/{catalog_item}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Change Requests matching the query criteria. Change Requests are used to track and manage changes to IT systems and services..
Endpoint: change_requests
Parameters: sysparm_query
Method: GET
Description: Retrieves a Change Request..
Endpoint: change_requests/{change_request}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Client Scripts matching the query criteria. Client Scripts are used to add custom JavaScript functionality to ServiceNow forms and views..
Endpoint: client_scripts
Parameters: sysparm_query
Method: GET
Description: Retrieves a Client Script..
Endpoint: client_scripts/{client_script}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Communication Logs matching the query criteria. Communication Logs track communications between users and customers..
Endpoint: communication_logs
Parameters: sysparm_query
Method: GET
Description: Retrieves a Communication Log..
Endpoint: communication_logs/{communication_log}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Data Sources matching the query criteria. Data Sources are used to connect to external data sources..
Endpoint: data_sources
Parameters: sysparm_query
Method: GET
Description: Retrieves a Data Source..
Endpoint: data_sources/{data_source}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Documents matching the query criteria. Documents are files that are stored in ServiceNow..
Endpoint: documents
Parameters: sysparm_query
Method: GET
Description: Retrieves a Document..
Endpoint: documents/{document}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Emails matching the query criteria. Emails are electronic messages that are sent and received in ServiceNow..
Endpoint: emails
Parameters: sysparm_query
Method: GET
Description: Retrieves an Email..
Endpoint: emails/{email}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Escalations matching the query criteria. Escalations are used to automatically escalate incidents and other records to the appropriate personnel when they meet certain criteria..
Endpoint: escalations
Parameters: sysparm_query
Method: GET
Description: Retrieves an Escalation..
Endpoint: escalations/{escalation}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Field Watchers matching the query criteria. Field Watchers are used to monitor changes to fields on records..
Endpoint: field_watchers
Parameters: sysparm_query
Method: GET
Description: Retrieves a Field Watcher..
Endpoint: field_watchers/{field_watcher}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Flows matching the query criteria. Flows are used to automate business processes in ServiceNow..
Endpoint: flows
Parameters: sysparm_query
Method: GET
Description: Retrieves a Flow..
Endpoint: flows/{flow}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Forms matching the query criteria. Forms are used to collect data from users in ServiceNow..
Endpoint: forms
Parameters: sysparm_query
Method: GET
Description: Retrieves a Form..
Endpoint: forms/{form}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Glide Records matching the query criteria. Glide Records are used to access and manipulate records in ServiceNow..
Endpoint: glide_records
Parameters: sysparm_query
Method: GET
Description: Retrieves a Glide Record..
Endpoint: glide_records/{glide_record}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Groups matching the query criteria. Groups are used to organize users and define access permissions in ServiceNow..
Endpoint: groups
Parameters: sysparm_query
Method: GET
Description: Retrieves a Group..
Endpoint: groups/{group}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Incidents matching the query criteria. Incidents are unplanned interruptions to service that require immediate attention..
Endpoint: incidents
Parameters: sysparm_query
Method: GET
Description: Retrieves an Incident..
Endpoint: incidents/{incident}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Integrations matching the query criteria. Integrations are used to connect ServiceNow with external systems and applications..
Endpoint: integrations
Parameters: sysparm_query
Method: GET
Description: Retrieves an Integration..
Endpoint: integrations/{integration}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Journal Fields matching the query criteria. Journal Fields are used to track changes to records in ServiceNow..
Endpoint: journal_fields
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Knowledge Articles matching the query criteria. Knowledge Articles are articles that contain information about products.
Endpoint: services
Parameters: and processes.
Method: GET
Description: Retrieves a Knowledge Article..
Endpoint: knowledge_articles/{knowledge_article}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Macros matching the query criteria. Macros are used to automate tasks in ServiceNow..
Endpoint: macros
Parameters: sysparm_query
Method: GET
Description: Retrieves a Macro..
Endpoint: macros/{macro}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Menus matching the query criteria. Menus are used to organize and display navigation links in ServiceNow..
Endpoint: menus
Parameters: sysparm_query
Method: GET
Description: Retrieves a Menu..
Endpoint: menus/{menu}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Messages matching the query criteria. Messages are used to communicate with users in ServiceNow..
Endpoint: messages
Parameters: sysparm_query
Method: GET
Description: Retrieves a Message..
Endpoint: messages/{message}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Notifications matching the query criteria. Notifications are used to alert users about events in ServiceNow..
Endpoint: notifications
Parameters: sysparm_query
Method: GET
Description: Retrieves a Notification..
Endpoint: notifications/{notification}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Order Guides matching the query criteria. Order Guides are used to guide users through the process of ordering products and services..
Endpoint: order_guides
Parameters: sysparm_query
Method: GET
Description: Retrieves an Order Guide..
Endpoint: order_guides/{order_guide}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Plugins matching the query criteria. Plugins are used to extend the functionality of ServiceNow..
Endpoint: plugins
Parameters: sysparm_query
Method: GET
Description: Retrieves a Plugin..
Endpoint: plugins/{plugin}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Problems matching the query criteria. Problems are known issues that have not yet been resolved..
Endpoint: problems
Parameters: sysparm_query
Method: GET
Description: Retrieves a Problem..
Endpoint: problems/{problem}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Processes matching the query criteria. Processes are workflows that define the steps required to complete a task..
Endpoint: processes
Parameters: sysparm_query
Method: GET
Description: Retrieves a Process..
Endpoint: processes/{process}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Reports matching the query criteria. Reports are used to display data in a visually appealing format..
Endpoint: reports
Parameters: sysparm_query
Method: GET
Description: Retrieves a Report..
Endpoint: reports/{report}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Saved Searches matching the query criteria. Saved Searches are used to save and reuse search criteria..
Endpoint: saved_searches
Parameters: sysparm_query
Method: GET
Description: Retrieves a Saved Search..
Endpoint: saved_searches/{saved_search}
Parameters: sysparm_query
Method: GET
Description: Retrieves a list of Schedules matching the query criteria. Schedules are used to define when and how often tasks should be run..
Endpoint: schedules
Parameters: sysparm_query
Method: GET
Description: Retrieves a Schedule..
Endpoint: schedules/{schedule}
Parameters: sysparm_query
FAQ
How do I obtain an access token for ServiceNow?
Visit https://developer.servicenow.com/app.do and sign in with your ServiceNow account. Then navigate to the 'Tokens' section and click 'Generate Access Token'.
What's the rate limit for authenticated requests to the ServiceNow API?
The rate limit for authenticated requests is 200 requests per minute per instance.
Can I get a sandbox account for testing the ServiceNow API?
Yes, you can request a sandbox account from the ServiceNow developer portal at https://developer.servicenow.com/app.do.
How do I determine the API version I should use?
The API version you use should match the version of ServiceNow you're working with. The latest API version is always recommended.
Is there a way to get help with using the ServiceNow API?
Yes, you can access the ServiceNow Developer Community at https://developer.servicenow.com/community for support and resources.