GET v1/CommercialCustomers/{parentEntityID}/BusinessContacts

Get a list of additional/business contacts for a customer (for 3rd party devs)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
parentEntityID

Id of parent entity

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of contacts

Collection of AdditionalContactDTO
NameDescriptionTypeAdditional information
EntityID

The ID of the entity

integer

None.

ParentEntityID

The ID of the parent entity

integer

None.

PrimaryContact

Indicates ifit is primary contact

boolean

None.

FirstName

First name of contact

string

None.

MiddleName

Middle name of contact

string

None.

LastName

Last name of contact

string

None.

DOB

Date of birth

date

None.

MaritalStatusID

The ID of the marital status

byte

None.

Gender

Gender

string

None.

MaritalStatus

Marital status

string

None.

PreferredEmailAddress

Preferred email address

string

None.

PreferredPhoneNumber

Preferred phone number

string

None.

RelationID

The ID of the relation

integer

None.

Relation

Relation

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EntityID": 1,
    "ParentEntityID": 2,
    "PrimaryContact": true,
    "FirstName": "sample string 4",
    "MiddleName": "sample string 5",
    "LastName": "sample string 6",
    "DOB": "2026-08-15T08:27:15.6279663+00:00",
    "MaritalStatusID": 64,
    "Gender": "sample string 7",
    "MaritalStatus": "sample string 8",
    "PreferredEmailAddress": "sample string 9",
    "PreferredPhoneNumber": "sample string 10",
    "RelationID": 1,
    "Relation": "sample string 11"
  },
  {
    "EntityID": 1,
    "ParentEntityID": 2,
    "PrimaryContact": true,
    "FirstName": "sample string 4",
    "MiddleName": "sample string 5",
    "LastName": "sample string 6",
    "DOB": "2026-08-15T08:27:15.6279663+00:00",
    "MaritalStatusID": 64,
    "Gender": "sample string 7",
    "MaritalStatus": "sample string 8",
    "PreferredEmailAddress": "sample string 9",
    "PreferredPhoneNumber": "sample string 10",
    "RelationID": 1,
    "Relation": "sample string 11"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAdditionalContactDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <AdditionalContactDTO>
    <DOB>2026-08-15T08:27:15.6279663+00:00</DOB>
    <EntityID>1</EntityID>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 7</Gender>
    <LastName>sample string 6</LastName>
    <MaritalStatus>sample string 8</MaritalStatus>
    <MaritalStatusID>64</MaritalStatusID>
    <MiddleName>sample string 5</MiddleName>
    <ParentEntityID>2</ParentEntityID>
    <PreferredEmailAddress>sample string 9</PreferredEmailAddress>
    <PreferredPhoneNumber>sample string 10</PreferredPhoneNumber>
    <PrimaryContact>true</PrimaryContact>
    <Relation>sample string 11</Relation>
    <RelationID>1</RelationID>
  </AdditionalContactDTO>
  <AdditionalContactDTO>
    <DOB>2026-08-15T08:27:15.6279663+00:00</DOB>
    <EntityID>1</EntityID>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 7</Gender>
    <LastName>sample string 6</LastName>
    <MaritalStatus>sample string 8</MaritalStatus>
    <MaritalStatusID>64</MaritalStatusID>
    <MiddleName>sample string 5</MiddleName>
    <ParentEntityID>2</ParentEntityID>
    <PreferredEmailAddress>sample string 9</PreferredEmailAddress>
    <PreferredPhoneNumber>sample string 10</PreferredPhoneNumber>
    <PrimaryContact>true</PrimaryContact>
    <Relation>sample string 11</Relation>
    <RelationID>1</RelationID>
  </AdditionalContactDTO>
</ArrayOfAdditionalContactDTO>