Retrieves the company contact with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "c7322ac8-e99c-4326-ad7e-e93334cc0713",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "be69ca70-213b-4b0b-9a12-07f24df2f924",
"company_code": "sample string 5",
"company": {
"id": "38ec9c5c-78f5-4bb6-9e12-9055c12b8d62",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-09T09:52:38.0437623+00:00",
"sales_territory_id": "b1cd031e-7b91-439b-ab85-83959705a7ff",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4421bb20-887f-4556-8741-fcdcca9dffa4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c621fac-432b-4bd2-8aa9-cb703d6a6528",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "64059580-4b76-449b-97b7-2d7368ba9223",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00caf7e3-507c-4bd7-8809-3277ca2250fe",
"db_currency_id": "248f7f14-240b-4efc-8ec8-3c6b7e6d9bda",
"db_language_id": "add4c10c-6596-4ff3-b881-4b117221500c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-03-09T09:52:38.0437623+00:00"
},
"modified_dateutc": "2026-03-09T09:52:38.0437623+00:00"
},
"marketing_segment_id": "056c6d2e-d9e7-486b-bbb4-15cca2064162",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b433de4a-4c52-4f5e-a8de-9d31c991c0cc",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "cc5aa371-09a2-4dda-8f80-69316b8f6a34",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "99f3eef7-78a1-4ce9-ba01-935870b3e384",
"db_country_code": "sample string 28",
"feelist_id": "69d65c7a-8847-4843-ad9d-ece0795a20e7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "72eed072-e3f1-4914-8407-024ac2b5d65c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "160fb451-ba8c-4d49-84ef-b4ee7700268f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-09T09:52:38.0437623+00:00",
"db_currency_id": "aa61986b-c65f-4747-ad9b-db1dbae63c2b",
"db_currency_code": "sample string 10"
},
"company_type_id": "28db3565-29fe-415d-bf48-d5e57e8dce96",
"company_type_name": "sample string 32",
"company_type": {
"id": "47ef13d0-5f31-45bf-9314-e8f93f0dc59c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "faf36a9b-208d-46e9-8165-7a1549d480ac",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c5a5e360-3944-4458-a666-34cc7e59b4f8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a72e89c1-5318-4c8f-a71c-cd94b9ae8eb2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7c9897c8-b043-4ee4-8ee4-e0341e44a95c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "30c8f663-f86c-4081-8c60-6d59987a6014",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-09T09:52:38.0437623+00:00"
},
"company_sector_id": "8c5cb46c-994b-4e84-989a-4ab136f1cb93",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "073ca771-7e25-46dd-9e2d-6404d81bddc8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "483063c6-028a-4321-bdb2-087b9b60d2d5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db70a7a5-e2cd-47ef-ae03-a4041a18841b",
"account_manager_user_code": "sample string 56",
"company_status_id": "3c9e6625-7462-4f86-ab19-04761e4a015a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-09T09:52:38.0437623+00:00",
"id2": 60
},
"db_language_id": "961c9e82-c6f4-4818-8c5c-4e0f25d837f4",
"db_language_code": "sample string 7",
"db_title_id": "64f803a1-1f08-4d00-931c-5c5e4812ba1e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-09T09:52:38.0437623+00:00",
"create_date": "2026-03-09T09:52:38.0437623+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-03-09T09:52:38.0437623+00:00"
}