Get a Customer

GET /customers/{id} — Use this method to retrieve the customer record with the specified internal ID.

Parameters

Path parameters

Path parameter	Required / Optional	Description	Type
`{id}`	Required	The internal ID of the customer.	integer

Path parameter

Required / Optional

Description

Type

{id}

Required

The internal ID of the customer.

integer

Query string parameter

Path parameter	Required / Optional	Description	Type
`expand`	Optional	A comma-separated list of attributes available for expansion. The comma-separated list may include spaces (or `%20` in the URL encoded string). Note: The `expand` value must contain only attributes referencing a supported object type. If `return_object` is set to any value other than `0` (zero), and the comma-separated list includes at least one attribute that is not available for expansion, the request fails — an error is returned and the object is not added or updated. For more information about attributes available for expansion and supported object types, see Available Expansions and Supported Object Types.	string
`fields`	Optional	A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the customer returned. Response Data Modifiers.	string
`filterSetId`	Optional	The internal ID of the filter set to be applied. When specified, the response includes only data that is available when the specified filter set is active in SuiteProjects Pro. The filter set with the specified internal ID must exist and must be associated with the user who authorized the application as per the access token. Otherwise and by default, the primary filter set associated with the user who authorized the application is applied.	integer

Path parameter

Required / Optional

Description

Type

expand

Optional

A comma-separated list of attributes available for expansion. The comma-separated list may include spaces (or %20 in the URL encoded string).

Note:

The expand value must contain only attributes referencing a supported object type. If return_object is set to any value other than 0 (zero), and the comma-separated list includes at least one attribute that is not available for expansion, the request fails — an error is returned and the object is not added or updated. For more information about attributes available for expansion and supported object types, see Available Expansions and Supported Object Types.

string

fields

Optional

A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the customer returned. Response Data Modifiers.

string

filterSetId

Optional

The internal ID of the filter set to be applied.

When specified, the response includes only data that is available when the specified filter set is active in SuiteProjects Pro. The filter set with the specified internal ID must exist and must be associated with the user who authorized the application as per the access token.
Otherwise and by default, the primary filter set associated with the user who authorized the application is applied.

integer

Response definitions

A successful request returns a JSON object with the following properties:

Property	Description
`data`	An array containing the customer object requested. See Returned Data.
`included`	An array of expanded objects, if the `expand` parameter was set in the request. See Referenced Objects and Expansion.
`meta`	An object containing information about objects referenced by internal ID in the `data` array (object type and internal ID). See Referenced Objects and Expansion.
`message`	A string containing a brief message about the status of your request — for example, `“Success”`.

Property

Description

data

An array containing the customer object requested. See Returned Data.

included

An array of expanded objects, if the expand parameter was set in the request.

See Referenced Objects and Expansion.

meta

An object containing information about objects referenced by internal ID in the data array (object type and internal ID).

See Referenced Objects and Expansion.

message

A string containing a brief message about the status of your request — for example, “Success”.

A failed request returns a JSON object with the following properties:

Property	Description
`message`	A string containing a brief message about the status of your request — for example, `“Customer #24 not found”`.

Property

Description

message

A string containing a brief message about the status of your request — for example, “Customer #24 not found”.

Sample request

            GET /rest/v1/customers/24 HTTP/1.1
Host: company-id.app.netsuitesuiteprojectspro.com
Authorization: Bearer <OAuth2_access_token>

In the example, <OAuth2_access_token> is the OAuth 2.0 access token obtained for the client application connecting to SuiteProjects Pro. See Authentication.

Sample response

            {
    "data": [
        {
            "address3": "",
            "invoiceEmailText": "",
            "companySizeId": 2,
            "state": "TX",
            "email": "",
            "rate": 250,
            "billingContactId": 467,
            "creditInvoiceLayoutId": 26,
            "updated": "2024-07-06 02:18:04",
            "id": 24,
            "territoryId": 0,
            "name": "First Software",
            "invoiceApprover": 56,
            "zip": "78741",
            "costCenterId": 0,
            "billingCode": "",
            "type": "C",
            "invoiceText": "",
            "address1": "2300 Oracle Way",
            "primaryContactId": 467,
            "invoiceLayoutId": 15,
            "statements": false,
            "shippingContactId": 1268,
            "externalId": "",
            "soldToContactId": 1268,
            "terms": "",
            "currency": "USD",
            "web": "",
            "invoiceApprovalProcess": 0,
            "city": "Austin",
            "fax": "603.555.0100",
            "syncWorkspace": false,
            "company": "Example Company",
            "customerLocationId": 12,
            "country": "",
            "customerSourceId": 0,
            "businessTypeId": 0,
            "address4": "",
            "isActive": true,
            "userId": 0,
            "invoicePrefix": "",
            "phone": "603.555.0100",
            "address2": "",
            "accountingCode": "",
            "created": "2008-10-28 09:21:47",
            "notes": ""

        }
    ],
    "message": "success"
}