Get a Contact

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

Parameters

Path parameters

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

Path parameter

Required / Optional

Description

Type

{id}

Required

The internal ID of the contact.

integer

Query string parameter

Path parameter	Required / Optional	Description	Type
`fields`	Optional	A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the contact 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

fields

Optional

A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the contact 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 contact object requested. See Returned Data.
`message`	A string containing a brief message about the status of your request — for example, `“Success”`.

Property

Description

data

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

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, `“Contact #24 not found”`.

Property

Description

message

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

Sample request

            GET /rest/v1/contacts/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": [
        {
            "jobTitle": "Head of Finance",
            "externalId": "",
            "mobile": "",
            "state": "",
            "email": "jdoe@example.com",
            "city": "",
            "fax": "",
            "updated": "2020-07-30 03:04:58",
            "id": 24,
            "lastName": "Doe",
            "firstName": "John",
            "country": "",
            "nickname": "J. Doe",
            "isActive": true,
            "phone": "",
            "address2": "",
            "created": "2019-05-18 09:51:46",
            "zip": "",
            "customerId": 68,
            "notes": "",
            "address1": "",
            "title": ""
        }
    ],
    "message": "success"
}