GET v1/Contacts/{id}
Get a Contact.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Contact| Name | Description | Type | Additional information |
|---|---|---|---|
Type |
Contact Type: Customer, Supplier |
ContactType |
Required |
SalesPersonId |
The User Id |
integer |
None. |
AccountNumber |
Account Number |
string |
Max length: 10 |
BillingId |
Parent company member id |
integer |
None. |
BillingCompany |
Billing Company |
string |
Max length: 50 |
AccountsFirstName |
Accounts contact first name |
string |
Max length: 50 |
AccountsLastName |
Accounts contact last name |
string |
Max length: 50 |
BillingEmail |
Billing Email |
string |
Max length: 50 |
AccountsPhone |
Accounts contact phone |
string |
Max length: 50 |
BillingCostCenter |
Alternative GL account of a Parent company if exists |
string |
None. |
CostCenter |
Alternative GL account |
string |
None. |
PriceColumn |
A price column name. Query ProductOptions to get a list of valid price column names. |
string |
None. |
PercentageOff |
Percentage Off Price Tier. Price discount on top of PriceColumn. |
decimal number |
Range: inclusive between 0 and 100 |
PaymentTerms |
Payment terms |
string |
None. |
TaxStatus |
Tax Status |
string |
None. |
TaxNumber |
Taxt Number |
string |
None. |
CreditLimit |
Credit Limit |
decimal number |
None. |
BalanceOwing |
Balance Owing (read-only) |
decimal number |
None. |
OnHold |
Hold Status |
boolean |
None. |
Group |
Group |
string |
None. |
SubGroup |
Subgroup |
string |
None. |
Stages |
Stages |
string |
None. |
AccountingIntegrationId |
Accounting Integration Ids for Xero, QuickBooks Online and QuickBooks Desktop (readonly) |
AccountingIntegrationId |
None. |
Id |
The unique Cin7 Id. |
integer |
None. |
CreatedDate |
Created Date |
date |
None. |
ModifiedDate |
Modified Date |
date |
None. |
IsActive |
Is Active |
boolean |
None. |
Company |
Company |
string |
Max length: 250 |
FirstName |
First Name |
string |
Max length: 250 |
LastName |
Last Name |
string |
Max length: 250 |
JobTitle |
Job Title |
string |
Max length: 250 |
|
A unique email address |
string |
None. |
|
Website |
Website |
string |
Max length: 50 |
Phone |
Phone |
string |
Max length: 50 |
Fax |
Fax |
string |
Max length: 50 |
Mobile |
Mobile |
string |
Max length: 50 |
Address1 |
Address 1 |
string |
Max length: 50 |
Address2 |
Address 2 |
string |
Max length: 50 |
City |
City |
string |
Max length: 50 |
State |
State |
string |
Max length: 50 |
PostCode |
Post Code |
string |
Max length: 50 |
Country |
Country |
string |
Max length: 50 |
PostalAddress1 |
Billing/Postal Address 1 |
string |
Max length: 50 |
PostalAddress2 |
Billing/Postal Address 2 |
string |
Max length: 50 |
PostalCity |
Billing/Postal City |
string |
Max length: 50 |
PostalPostCode |
Billing/Postal Post Code |
string |
Max length: 50 |
PostalState |
Billing/Postal State |
string |
Max length: 50 |
PostalCountry |
Billing/Postal Country |
string |
Max length: 50 |
Notes |
Notes |
string |
Max length: 250 |
IntegrationRef |
Integration reference. |
string |
None. |
CustomFields |
Custom fields. |
Dictionary of string [key] and Object [value] |
None. |
SecondaryContacts |
Secondary Contacts |
Collection of SubContact |
None. |
Response Formats
application/json, text/json
{
"id": 1,
"createdDate": "2025-11-25T04:07:01.4264401Z",
"modifiedDate": "2025-11-25T04:07:01.4264401Z",
"isActive": true,
"company": "Acme Corporation",
"firstName": "Jane",
"lastName": "Doe",
"jobTitle": "Managing Director",
"email": "jane@acmecorpation.com",
"website": "www.acmecorpation.com",
"phone": "(000) 123-4567",
"fax": "(000) 123-4567",
"mobile": "(000) 123-4567",
"address1": "1600 Amphitheatre Pkwy",
"address2": null,
"city": "Mountain View",
"state": "CA",
"postCode": "94043",
"country": "USA",
"postalAddress1": "Postal Address Line 1",
"postalAddress2": "Postal Address Line 2",
"postalCity": "Postal City",
"postalPostCode": "Postal Code",
"postalState": "State",
"postalCountry": "Country",
"notes": "Sample client contact.",
"integrationRef": "MY-INTEGRATION-REF",
"customFields": null,
"secondaryContacts": [
{
"id": 1,
"company": "Bob's Company",
"firstName": "Bob",
"lastName": "Joans",
"jobTitle": "Freelance Consultant",
"email": "bob@acmecorpation.com",
"mobile": null,
"phone": null
},
{
"id": 2,
"company": null,
"firstName": "Lara",
"lastName": "Croft",
"jobTitle": "Accountant",
"email": "lara@acmecorpation.com",
"mobile": null,
"phone": null
}
],
"type": "Customer",
"salesPersonId": 0,
"accountNumber": null,
"billingId": 0,
"billingCompany": "Billing Company Name",
"accountsFirstName": "Account Contact First Name",
"accountsLastName": "Account Contact Last Name",
"billingEmail": "",
"accountsPhone": "(000) 123-4567",
"billingCostCenter": null,
"costCenter": null,
"priceColumn": "Retail",
"percentageOff": null,
"paymentTerms": null,
"taxStatus": null,
"taxNumber": null,
"creditLimit": 0.0,
"balanceOwing": 0.0,
"onHold": null,
"group": null,
"subGroup": null,
"stages": null,
"accountingIntegrationId": {
"xero": "12345",
"quickBooksOnline": "12345",
"quickBooksDesktop": null
}
}
