NetSuite SuiteTalk icon

NetSuite SuiteTalk

NetSuite REST API

Get Record

AI-generated

Summary

Retrieve a specific NetSuite record by its internal or external ID, optionally restricting returned fields and expanding sub-resources.

Inputs

  • Record Type (required) — Select the type of NetSuite record to retrieve.
  • Custom Record Script ID (required) — Specify the script ID for custom record types, required when Record Type is 'Custom'.
  • ID (required) — The internal identifier of the record to retrieve. Prefix with 'eid:' to use the external ID.
  • Restrict Returned Fields — Optionally specify fields and sublists to include in the returned record data.
  • Expand Sub-Resources (required) — Choose whether to expand all sublists, sublist lines, and sub-records automatically.
  • Simple Enum Format (required) — Return enumeration values showing only their internal ID values if enabled.
  • API Version (required) — API version to be used; currently only 'V1' is supported.
  • Options — Additional options such as returning the full response and setting the max number of retries on server errors.

Output shape

a single record

Returns the full record data as JSON for the specified Record Type and ID. If 'Expand Sub-Resources' is enabled, all sublists and sub-records are automatically expanded. If 'Restrict Returned Fields' is set, only those fields and sublists are returned. Enumeration fields format depends on 'Simple Enum Format'. The response is wrapped in a JSON object under the 'json' property.

Links

Discussion