ServiceNow REST / Table API Builder

Any table the integration user can read or write: incident, sys_user, cmdb_ci_server, your own u_ tables and scoped x_ tables. ACLs apply exactly as in the UI. The builder suggests fields, a filter and sample bodies for the tables listed on this page, and every option works for any other table too.

It is https://<instance>.service-now.com/api/now/table/<table> for a list and /api/now/table/<table>/<sys_id> for one record. Options go in the query string as sysparm_* parameters, for example ?sysparm_query=active=true&sysparm_limit=10. The builder above writes the URL for you and encodes the query correctly.

Put the encoded query in sysparm_query, URL-encoded: = becomes %3D and ^ becomes %5E. The easiest way to get the query is to build the filter on a list, then right-click the breadcrumb and choose Copy query. Paste it into the filter box above and the builder shows it in plain English.

Set sysparm_limit to a page size such as 1,000, add a stable sort such as ORDERBYsys_created_on to the query, and increase sysparm_offset by the page size on every call until fewer records come back than you asked for. Tick Fetch every page above and the Python, PowerShell, JavaScript and ServiceNow code does this loop for you. The X-Total-Count response header gives the total.

Variable answers are not fields on sc_req_item. Read sc_item_option_mtom with sysparm_query=request_item.number=RITM0010001 and sysparm_fields=sc_item_option.item_option_new.name,sc_item_option.value: one row per variable, with its name and answer. Pick that table in the builder to get the request ready-made.

First read the item with GET /api/sn_sc/servicecatalog/items/{sys_id} to see its variable names. Then POST /api/sn_sc/servicecatalog/items/{sys_id}/order_now with { "sysparm_quantity": "1", "variables": { … } }. The response holds the new request number. Both are in the builder under Service Catalog API.

Use the Identification and Reconciliation API, POST /api/now/identifyreconcile, instead of the Table API. It matches each CI to existing records with the class’s identification rule and only inserts when nothing matches. /api/now/identifyreconcile/query tells you what it would do without changing anything.

Yes. Choose Call any endpoint, pick the method, and enter the resource path, for example /api/x_acme/onboarding/employees, with any query parameters and a JSON body. You get the same cURL, PowerShell, Python, Node, Postman and RESTMessageV2 code. Pasting such a URL in the first box fills it in.

In the ServiceNow Table API they behave the same: both change only the fields you send and leave the others alone. PATCH is the more common choice because it says what it does. Neither one clears fields you leave out.

By default the API returns stored values, and a reference field stores the sys_id of the record it points to. Set sysparm_display_value=true to get the name users see, or all to get both. Add sysparm_exclude_reference_link=true to drop the extra link object.

Use sn_ws.RESTMessageV2 in a server script, and keep the credentials in a Basic auth or OAuth profile instead of the script. Choose the ServiceNow tab above for a script that reads the profile from a system property, checks the status code and parses the JSON result.

A dedicated integration user with only the roles it needs and Web service access only ticked on the user record, so it cannot sign in to the UI. Table API access follows the same ACLs as the UI, so a 403 usually means the user is missing a role or an ACL.

No. The builder only writes text. It never contacts your instance and never asks for credentials: the generated code reads SN_USER and SN_PASSWORD, or SN_TOKEN, from environment variables. Shared links keep the request after the #, so it is not sent to any server.