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": "facb7529-e90c-4e39-b230-d89ddaed2ae0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "112b1cca-60c1-4205-9e78-b08c6cdc3395",
"company_code": "sample string 5",
"company": {
"id": "e3baa7e6-c4eb-4241-b851-01d9ea857e7a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-31T18:03:14.4728497+00:00",
"sales_territory_id": "6dd91a6a-57b4-4337-82f3-129ce5fcfa85",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "57d01de8-aca9-41a2-a1ee-8526913bcc33",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "941c8b3f-4286-41c3-aa90-a81367b9d3e5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ba2ea67-ef7d-46ac-93de-e5d42584d26d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "00d1ae51-5a07-4366-974a-1ad7173a3b9b",
"db_currency_id": "167dc370-a4f3-42de-bbfe-18d49f4f406c",
"db_language_id": "26fa205b-c1c2-4e47-9716-f7e802299159",
"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-08-31T18:03:14.4728497+00:00"
},
"modified_dateutc": "2026-08-31T18:03:14.4728497+00:00"
},
"marketing_segment_id": "8a887795-fb55-4972-9b9e-397252ba159e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "94885407-55b7-45eb-8b18-b184986f5d0e",
"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": "3b72dffc-b676-4133-8585-414093757240",
"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": "76f29be2-35f2-49c4-af39-f2c883ae5b17",
"db_country_code": "sample string 28",
"feelist_id": "9675ab77-c732-42ec-a52d-33db4f54a237",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f313135e-da60-4b2c-bab3-56b045ad7191",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "547cdbe4-c703-4568-b69d-7b9c12ddded8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-31T18:03:14.4728497+00:00",
"db_currency_id": "3b36ce19-3a5a-4fdd-af92-5703ef5a3c4f",
"db_currency_code": "sample string 10"
},
"company_type_id": "de7199e1-fcef-4514-8edd-6eaeb8a9bdfd",
"company_type_name": "sample string 32",
"company_type": {
"id": "dbc27d7c-8c56-44c3-bacd-f62200156ecd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c2262a0-33ad-4e9f-9c14-58ab54661325",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9415c8ea-c006-4912-bd94-800bfbdcc24a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2392bafd-b314-4d1b-aa5c-ae9ebc89630d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "31202c53-278c-4d19-b36e-9af9f98208b4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d2d952fb-dc0c-4d68-9278-8a06a903a2ee",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-31T18:03:14.4728497+00:00"
},
"company_sector_id": "41921076-1124-4c8a-805e-fdab5c4d9d91",
"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": "ff9ba7c7-5c2d-4182-b8c8-d01ad4e1eae1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "296455b5-4a48-4abb-9d2f-711e925e6f14",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9f59a6c0-fb35-4c54-a6f0-6e6cf4ef8e70",
"account_manager_user_code": "sample string 56",
"company_status_id": "6ef57289-50fd-4716-9335-82d992406a1c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-31T18:03:14.4728497+00:00",
"id2": 60
},
"db_language_id": "e04095cb-b853-4675-9ceb-9495bbeb7f7c",
"db_language_code": "sample string 7",
"db_title_id": "17f97501-a036-4259-99dc-0690a2a297ed",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-31T18:03:14.4728497+00:00",
"create_date": "2026-08-31T18:03:14.4728497+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-08-31T18:03:14.4728497+00:00"
}