NetSuite REST Web Services Prerequisites and Setup

To use REST web services, the relevant features must be enabled in your account. Additionally, the
REST web services user must have the required permissions assigned to the user’s role. See the
following table for information about enabling the required features and assigning the required
permissions.


If you create a new role, or if you use an existing custom role or a standard role that does not
have the required permissions by default, you can assign the permissions manually.

To assign the required permissions to a user’s role:

  1. Go to Setup > Users/Roles > User Management > Manage Roles.

  2. Locate the role you want to modify. Click the corresponding Edit or Customize link.

  3. On the Permissions subtab, click Setup.

  4. In the Permission list, select REST Web Services.

SuiteTalk REST Web Services

REST Web Services Prerequisites and Setup 9

  1. In the Level list, select Full.

  2. Click Add.

  3. On the Permissions subtab, click Setup.

  4. In the Permission list, select Log in using Access Tokens.

  5. In the Level list, select Full.

  6. Click Add.

  7. On the Permissions subtab, click Reports.

  8. In the Permission list, select SuiteAnalytics Workbook.

  9. In the Level list, select Edit.

  10. Click Add.

  11. Click Save.

REST Web Services URL Schema and Account- Specific URLs
You can only access REST web services using account-specific domains. Account-specific domains are
unique to your account because they contain your account ID as part of the domain name. These
domains do not change when your account is moved to a different data center.
When using account-specific domains, dynamic domain discovery is not needed.
The format of an account-specific domain name is the following: <account
ID>.<service>.netsuite.com. For example, if your account ID is 123456, your account-specific domain
for REST web services is: 123456.suitetalk.api.netsuite.com
You can find the service URL for SuiteTalk (SOAP and REST web services) at Setup > Company > Setup
Tasks > Company Information, on the Company URLs subtab. When you build a client application, you
must ensure that the service URL is a configurable parameter.

Important: The examples in this document use demo123 as the account ID. Substitute this with your
own account ID.

You can access NetSuite resources through REST web services by using URLs specific to either record
or query service.
A URL for a REST resource looks like the following.

The URL consists of the following parts:

  1. Protocol

  2. The account ID of your NetSuite account

  3. The domain name for REST web services

  4. The complete REST API services endpoint

SuiteTalk REST Web Services

REST Web Services URL Schema and Account-Specific URLs 10

  1. The specific services that is being accessed, for example, record, query, or other service

  2. The service version, which specific to each service

  3. The optional sub-service, for example, metadata-catalog, suiteql, or dataset

  4. Query parameters

2024 DATABASICS, Inc