GET v1/Customers/{id}/Contacts
Get the company contacts.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The id of the Customer. |
integer |
Required. |
Body Parameters
None.
Response Information
Resource Description
The company's contacts object.
Collection of CompanyContact| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyContactId | integer |
None. |
|
| Function | string |
None. |
|
| VatNumber |
Gets or sets the VAT number of the company. |
string |
Max length: 50 |
| FullName |
Gets or sets the full name. |
string |
Max length: 200 |
| DateOfBirth |
Gets or sets the DateOfBirth. |
date |
None. |
| Gender |
Gets or sets the gender. |
string |
Max length: 1 |
| PersonTitle |
Gets or sets the person title. |
string |
Max length: 50 |
| MiddleName |
Gets or sets the middle name. |
string |
Max length: 50 |
| FirstName |
Gets or sets the first name. |
string |
Max length: 50 |
| LastName |
Gets or sets the last name. |
string |
Max length: 50 |
| LastNamePrefix |
Gets or sets the prefix of the last name . |
string |
Max length: 50 |
| Id |
Gets or sets the identifier. |
integer |
Required |
| CompanyName |
Gets or sets the name of the company. |
string |
Max length: 100 |
| Address |
Gets or sets the address. |
string |
Max length: 100 |
| Address2 |
Gets or sets the address2. |
string |
Max length: 100 |
| StreetAddress |
Gets or sets the street address. |
string |
Max length: 100 |
| StreetAddressNumber |
Gets or sets the street address number. |
string |
Max length: 20 |
| StreetAddressExtension |
Gets or sets the street address extension. |
string |
Max length: 20 |
| PostalCode |
Gets or sets the postal code. |
string |
Max length: 50 |
| City |
Gets or sets the city. |
string |
Max length: 100 |
| CountryId |
Gets or sets the country identifier. |
integer |
None. |
| CountryCode |
Gets or sets the country code. |
string |
Max length: 50 |
| CountryName |
Gets the country name |
string |
Max length: 50 |
|
Gets or sets the email. |
string |
Max length: 100 |
|
| Phone |
Gets or sets the phone. |
string |
Max length: 50 |
| Phone2 |
Gets or sets the 2nd phone. |
string |
Max length: 50 |
| StateProvince |
Gets or sets the state or province. |
string |
Max length: 100 |
| StateProvinceCode |
Gets or sets the state or province Code. |
string |
Max length: 50 |
Response Formats
application/json, text/json
[
{
"CompanyContactId": 1,
"Function": "sample string 2",
"VatNumber": "sample string 3",
"FullName": "sample string 4",
"DateOfBirth": "2026-01-11T16:13:36.1623163+01:00",
"Gender": "sample string 5",
"PersonTitle": "sample string 6",
"MiddleName": "sample string 7",
"FirstName": "sample string 8",
"LastName": "sample string 9",
"LastNamePrefix": "sample string 10",
"Id": 11,
"CompanyName": "sample string 12",
"Address": "sample string 13",
"Address2": "sample string 14",
"StreetAddress": "sample string 15",
"StreetAddressNumber": "sample string 16",
"StreetAddressExtension": "sample string 17",
"PostalCode": "sample string 18",
"City": "sample string 19",
"CountryId": 1,
"CountryCode": "sample string 20",
"CountryName": null,
"EMail": "sample string 21",
"Phone": "sample string 22",
"Phone2": "sample string 23",
"StateProvince": "sample string 24",
"StateProvinceCode": "sample string 25"
},
{
"CompanyContactId": 1,
"Function": "sample string 2",
"VatNumber": "sample string 3",
"FullName": "sample string 4",
"DateOfBirth": "2026-01-11T16:13:36.1623163+01:00",
"Gender": "sample string 5",
"PersonTitle": "sample string 6",
"MiddleName": "sample string 7",
"FirstName": "sample string 8",
"LastName": "sample string 9",
"LastNamePrefix": "sample string 10",
"Id": 11,
"CompanyName": "sample string 12",
"Address": "sample string 13",
"Address2": "sample string 14",
"StreetAddress": "sample string 15",
"StreetAddressNumber": "sample string 16",
"StreetAddressExtension": "sample string 17",
"PostalCode": "sample string 18",
"City": "sample string 19",
"CountryId": 1,
"CountryCode": "sample string 20",
"CountryName": null,
"EMail": "sample string 21",
"Phone": "sample string 22",
"Phone2": "sample string 23",
"StateProvince": "sample string 24",
"StateProvinceCode": "sample string 25"
}
]
application/xml, text/xml
<ArrayOfCompanyContact xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CompanyContact>
<Id>11</Id>
<CompanyName>sample string 12</CompanyName>
<Address>sample string 13</Address>
<Address2>sample string 14</Address2>
<StreetAddress>sample string 15</StreetAddress>
<StreetAddressNumber>sample string 16</StreetAddressNumber>
<StreetAddressExtension>sample string 17</StreetAddressExtension>
<PostalCode>sample string 18</PostalCode>
<City>sample string 19</City>
<CountryId>1</CountryId>
<CountryCode>sample string 20</CountryCode>
<EMail>sample string 21</EMail>
<Phone>sample string 22</Phone>
<Phone2>sample string 23</Phone2>
<StateProvince>sample string 24</StateProvince>
<StateProvinceCode>sample string 25</StateProvinceCode>
<VatNumber>sample string 3</VatNumber>
<FullName>sample string 4</FullName>
<DateOfBirth>2026-01-11T16:13:36.1623163+01:00</DateOfBirth>
<Gender>sample string 5</Gender>
<PersonTitle>sample string 6</PersonTitle>
<MiddleName>sample string 7</MiddleName>
<FirstName>sample string 8</FirstName>
<LastName>sample string 9</LastName>
<LastNamePrefix>sample string 10</LastNamePrefix>
<CompanyContactId>1</CompanyContactId>
<Function>sample string 2</Function>
</CompanyContact>
<CompanyContact>
<Id>11</Id>
<CompanyName>sample string 12</CompanyName>
<Address>sample string 13</Address>
<Address2>sample string 14</Address2>
<StreetAddress>sample string 15</StreetAddress>
<StreetAddressNumber>sample string 16</StreetAddressNumber>
<StreetAddressExtension>sample string 17</StreetAddressExtension>
<PostalCode>sample string 18</PostalCode>
<City>sample string 19</City>
<CountryId>1</CountryId>
<CountryCode>sample string 20</CountryCode>
<EMail>sample string 21</EMail>
<Phone>sample string 22</Phone>
<Phone2>sample string 23</Phone2>
<StateProvince>sample string 24</StateProvince>
<StateProvinceCode>sample string 25</StateProvinceCode>
<VatNumber>sample string 3</VatNumber>
<FullName>sample string 4</FullName>
<DateOfBirth>2026-01-11T16:13:36.1623163+01:00</DateOfBirth>
<Gender>sample string 5</Gender>
<PersonTitle>sample string 6</PersonTitle>
<MiddleName>sample string 7</MiddleName>
<FirstName>sample string 8</FirstName>
<LastName>sample string 9</LastName>
<LastNamePrefix>sample string 10</LastNamePrefix>
<CompanyContactId>1</CompanyContactId>
<Function>sample string 2</Function>
</CompanyContact>
</ArrayOfCompanyContact>