Skip to content

findCompanyContactsForUser ​

Retrieves a given Contact field (or fields) from a Company that the user is connected to. NOTE: v1 only supports field address1Name but can be easily extended when required. FYI: due to the contact record being owned/controlled by the company, not the user, caution needs to be taken on which fields are returned by this API. Currenlty only address1Name is supported.

Request ​

http
GET rest/user/contact/{companyId}

Parameters ​

Path Parameters:

ParameterTypeRequiredDescription
companyIdintegerYesCompany id of a wall the user is connected to.

Query Parameters:

ParameterTypeRequiredDescription
fieldsstring[]YesList of field names in format ?fields=address1Name&fields=address1Type etc

SAMPLE REQUEST curl --location 'http://localhost:8080/nextinteract-webapp/rest/user/contact/3?fields=address1Name'
--header 'x-nextinteract-authtoken: z7WEJKawbi3HBKgQdbvhJQ=='

Response ​

200 OK ​

json
{
    "results": [
        {
            "key": "address1Name",
            "value": "Randwick Hospital"
        }
    ]
}

Errors ​

ExceptionDescription
WSInvalidParameterExceptionSee Error Definitions
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSUserServiceExceptionSee Error Definitions