Batch API

Bundle multiple REST requests into one call

Jace Benson

Table of content
  1. Endpoint
  2. Request Body
  3. Key Points

Docs

The Batch API bundles multiple REST API requests into a single HTTP request, reducing network overhead and improving performance.

Endpoint

Method Endpoint Purpose
POST /api/now/v1/batch Execute multiple requests in one call

Request Body

{
  "batch_request": {
    "rest_requests": [
      {
        "method": "GET",
        "url": "/api/now/table/incident?sysparm_limit=1"
      },
      {
        "method": "POST",
        "url": "/api/now/table/incident",
        "headers": {
          "Content-Type": "application/json"
        },
        "body": {
          "short_description": "New incident"
        }
      }
    ]
  }
}

Key Points