Retrieves the 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": "7a24febd-24aa-4500-a2dc-14e2218eb55e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a33c429-6e55-4cca-97a7-8493853ad533",
"company_code": "sample string 5",
"company": {
"id": "3f145e88-3186-40e8-96ca-f987bc7ec2a3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-01T06:28:26.6085162+00:00",
"sales_territory_id": "36e8ad7c-76da-479f-bd66-0828fa402d10",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a0b933b6-1d92-452b-865b-fd7565f8d2dc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "984ff687-8822-49a9-a029-ae27e8528c63",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18910ec2-6f1f-4790-b9d0-8ef8937bd79f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db05def0-7772-4def-a078-0a22c60e2985",
"db_currency_id": "87c805d2-4d18-4c80-91eb-ed9050b3bc8a",
"db_language_id": "57044171-5b01-4ca8-b1ad-920c07167fa2",
"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-05-01T06:28:26.6085162+00:00"
},
"modified_dateutc": "2026-05-01T06:28:26.6085162+00:00"
},
"marketing_segment_id": "de05cbf1-a746-416c-b769-d5354aa65880",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "31d08fcf-4088-48ff-b05c-b8bed3741a77",
"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": "c4bac8c8-c527-4b02-8410-dd72ddb7cd51",
"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": "a5cebb0e-91e7-4595-b6f6-19ced4a6a0f7",
"db_country_code": "sample string 28",
"feelist_id": "58f6bd30-4c8d-4725-8941-f12a86f7e613",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1c3b9260-b66c-4f02-b2e1-6db2436d9cd4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0277d0e1-2ded-41d2-90b2-3192084596ca",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-01T06:28:26.6085162+00:00",
"db_currency_id": "ac198edf-8253-40ab-b57b-ec02e824594b",
"db_currency_code": "sample string 10"
},
"company_type_id": "94f59e8a-a8ba-4bd1-bd5f-eec6463cace2",
"company_type_name": "sample string 32",
"company_type": {
"id": "8d0fd426-4a9a-439d-bb45-7f73fb4d9333",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "493f7cd9-1fe2-4c7e-8127-77cab8ecdf87",
"sales_organization_code": "sample string 5"
},
"db_language_id": "317f3ff8-590e-45be-9b33-5e752ab2f9e4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3a4d4b6e-9f3c-4595-becc-bc44ff90c657",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d7f49d9f-be70-4d38-8b0a-1d6697cea747",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b3e02983-e76c-465f-ac06-c1635c4eaae6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-01T06:28:26.6085162+00:00"
},
"company_sector_id": "29cc0994-72fe-43be-9841-6b23e7398b9d",
"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": "329f737f-01fa-49b8-a8a6-5f31a762fb29",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4d403496-3ec5-4f2a-bb57-4cce148afa7a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e1c3bbde-5568-40ff-ba4e-e7cf7e7d111f",
"account_manager_user_code": "sample string 56",
"company_status_id": "c08a5669-d2d5-40d3-ad19-b7957584b665",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-01T06:28:26.6085162+00:00",
"id2": 60
},
"db_language_id": "eefb4f55-8df9-4853-952d-ac7850eb4630",
"db_language_code": "sample string 7",
"db_title_id": "a208f021-25e7-49aa-a907-23652ce9ee38",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-01T06:28:26.6085162+00:00",
"create_date": "2026-05-01T06:28:26.6085162+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-05-01T06:28:26.6085162+00:00"
}