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": "dd3b7fea-f58e-4eab-ba7b-c38717c0ec4b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0f0673f0-5349-4f91-82da-3f887abf6102",
"company_code": "sample string 5",
"company": {
"id": "09da8bd3-b789-4930-8572-bad14f18d44d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-28T12:55:00.8287873+00:00",
"sales_territory_id": "f83a3ebe-4b01-43ed-a7d8-a318ba5d4053",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "37341d5a-1701-430c-aff1-1c8bc8c2551d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9d7b293e-67c5-4296-9065-ed867bb3fcff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de8a8d63-bd29-4b35-8bc4-5021963e403f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a6957575-8b61-480f-96ae-61d077334454",
"db_currency_id": "e9ed5ea4-9ddf-4114-bab2-21004e571bea",
"db_language_id": "039a747b-3a99-4d71-a437-040b53b11286",
"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-01-28T12:55:00.8287873+00:00"
},
"modified_dateutc": "2026-01-28T12:55:00.8287873+00:00"
},
"marketing_segment_id": "4fbb10bb-87bf-4c14-9d98-45534d34425e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "248f8879-e44a-485d-bf6e-c060aa5d2767",
"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": "bb70711e-59d3-4685-a185-9f0ef78023ed",
"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": "98083125-b5d5-48e4-81a1-93ab1100a10d",
"db_country_code": "sample string 28",
"feelist_id": "ace35280-2b4b-4303-8800-a6041876be60",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "350b9d15-a9e5-4c76-bffb-d2768f7f9036",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "18eb108c-f7a1-4e68-8741-78be6bbda41c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-28T12:55:00.8287873+00:00",
"db_currency_id": "713785da-36d5-4ee1-8f07-6e719813bbff",
"db_currency_code": "sample string 10"
},
"company_type_id": "3d4f2e11-e7b8-4925-96db-bcd2f2aa92a6",
"company_type_name": "sample string 32",
"company_type": {
"id": "d757474b-a4a9-44c3-af1b-b74fe1793c63",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7497eb50-bf26-448e-937e-3f99547bb9fe",
"sales_organization_code": "sample string 5"
},
"db_language_id": "864b9951-e82a-4699-a0ce-f2182105ffd5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4aa22e87-64dc-4ae8-98e9-72234dfd376f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "13e2e37f-2400-49c1-a681-eff2185337a6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c81f3357-5f72-4c14-8767-fdabdca28aea",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-28T12:55:00.8287873+00:00"
},
"company_sector_id": "c013f986-d2fd-4359-9579-a96205ba3b81",
"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": "1da262ff-0206-41b8-8926-efd9c7377507",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "99b46751-60cf-48ce-8f4d-de8ee2199c4b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c30288b6-beb1-49c3-9459-6301adb1a8d7",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f472ee6-4d5a-412f-8a97-84a804a194f2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-28T12:55:00.8287873+00:00",
"id2": 60
},
"db_language_id": "1129ce52-6643-410e-a229-00bea61f7147",
"db_language_code": "sample string 7",
"db_title_id": "560a6f80-dfec-4ce8-8064-0c18a2af76c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-28T12:55:00.8287873+00:00",
"create_date": "2026-01-28T12:55:00.8287873+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-01-28T12:55:00.8287873+00:00"
}