NetSuite REST icon

NetSuite REST

Call NetSuite SuiteTalk REST operations.

Actions979

Customer → Get list of records

AI-generated

Summary

Retrieve a list of customer records via NetSuite’s REST API.

Inputs

  • isDebugMode — Include full request and response information in the output when enabled.
  • limit — Maximum number of results to return on a single page.
  • offset — Offset used to select a specific page of results.
  • Prefer — Request asynchronous execution with "respond-async"; when used, the response header Preference-applied: respond-async is returned.
  • q — Search query string to filter customer records.
  • X-NetSuite-Idempotency-Key — Unique idempotency key for asynchronous requests; ignored for synchronous calls.

Output shape

a list of Customer records (JSON objects).

If Debug Mode is enabled, each returned item includes request and response metadata. Pagination is handled via the limit and offset parameters; subsequent calls are required to retrieve additional pages.

Examples

Example 1: Retrieve the first 50 customers

isDebugMode: false; limit: 50; offset: 0; q: ''; Prefer: ''; X-NetSuite-Idempotency-Key: ''.

Example 2: Search customers whose name contains "Acme"

isDebugMode: false; limit: 20; offset: 0; q: 'name:Acme'; Prefer: ''; X-NetSuite-Idempotency-Key: ''.

Example 3: Asynchronously fetch customers with respond-async

isDebugMode: false; limit: 100; offset: 0; q: ''; Prefer: 'respond-async'; X-NetSuite-Idempotency-Key: '123e4567-e89b-12d3-a456-426614174000'.

Discussion