NetSuite SuiteTalk icon

NetSuite SuiteTalk

NetSuite REST API

Actions15

Get Metadata

AI-generated

Summary

Retrieve metadata from NetSuite in various formats including JSON listing record types, OpenAPI 3.0 specification, or JSON Schema describing record structure.

Inputs

  • Metadata Format (required) — Select the format for the metadata: JSON, OpenAPI 3.0, or JSON Schema.
  • Record Types — Comma-separated record types to retrieve metadata for; leave empty to fetch all record types (can be slow for highly customized accounts).
  • Options — Optional settings including whether to return the full response and max retry attempts on errors.

Output shape

a single JSON object containing the requested metadata in the chosen format

If 'Record Types' is empty, metadata for all record types is retrieved, which may be slow. The 'Options' allow requesting full HTTP response data instead of just the body and configuring retry behavior on errors.

Examples

Example 1: Retrieve metadata listing all record types in JSON format.

Set 'Metadata Format' to 'JSON (Record Type List)' and leave 'Record Types' empty.

Example 2: Retrieve full OpenAPI 3.0 specification for specified record types.

Set 'Metadata Format' to 'OpenAPI 3.0 (Swagger)', specify desired record types in 'Record Types', and optionally enable 'Full Response' to get full HTTP response.

Links

Discussion