Skip to content
IT Canvass
Integrations · Lesson

Table API

Quick answer

The inbound REST interface every integration starts with: endpoints, query parameters, pagination and access control.

Key takeaways

  • Table API respects ACLs, so the integration user needs roles
  • sysparm_fields keeps payloads small and fast
  • Page with limit and offset instead of pulling everything
  • Key on sys_id, not on display values

Endpoints

The Table API exposes every table at /api/now/table/{table}. GET lists or reads, POST creates, PATCH updates and DELETE removes. Access is governed by the same ACLs as the UI, so an integration user needs real roles.

Query parameters that matter

Most integration problems are solved with four parameters.

  • sysparm_query takes an encoded query, the same string you copy from a list breadcrumb
  • sysparm_fields limits the payload, always set it
  • sysparm_display_value returns labels instead of sys_ids, or both with all
  • sysparm_limit and sysparm_offset control pagination

Practical rules

Integrations fail on volume and on assumptions about fields. Always request only the fields you use, page through results rather than pulling everything, and store sys_id as your key rather than number, because numbers can be regenerated in non production instances.

Want to learn this properly?

Our live, instructor-led ServiceNow Training covers this hands-on, with real projects and a certification path.

Check your understanding

  1. Which parameter limits returned columns?

    • A. sysparm_query
    • B. sysparm_fields
    • C. sysparm_limit
    • D. sysparm_view
    Show answer

    B. sysparm_fields

    sysparm_fields controls the payload shape and size.

  2. What should an integration store as the record key?

    • A. number
    • B. sys_id
    • C. short_description
    • D. created date
    Show answer

    B. sys_id

    sys_id is immutable, numbers can differ across instances.

Frequently asked questions

Table API or a scripted REST API?

Table API for straightforward record access. Scripted REST when you need business logic, a stable contract or a shape that differs from the table.

Why does the integration see fewer records than an admin?

ACLs apply. Give the integration user the minimum roles it needs and test with that account.
CallWhatsAppEnquire