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": "6cbccf78-c49f-46e7-9f7e-9725df290b83",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "49440edd-ef25-49ea-a1d6-248dac6142d8",
"company_code": "sample string 5",
"company": {
"id": "59256c3e-3f9d-40dc-a1f3-dbdf10099d47",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-10T19:33:08.9905675+00:00",
"sales_territory_id": "dfd75cfd-8384-4c74-92d3-8cc941526231",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4409ce3b-eba7-4e43-bb17-d0c3092bfd18",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0529ff55-0c4f-4787-9b46-e961d7596070",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2fc7e613-ed97-4404-ac15-eff6953083e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45aa32c0-a547-4586-a7d0-e432004182fe",
"db_currency_id": "e6059691-a805-4871-b3e4-5fe844530d3d",
"db_language_id": "8e025d3c-06af-461e-a432-228ec6993082",
"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-09-10T19:33:08.9905675+00:00"
},
"modified_dateutc": "2026-09-10T19:33:08.9905675+00:00"
},
"marketing_segment_id": "673aef1b-600c-4bdd-a5ad-275e29f5a769",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "af35f21e-b904-49c2-8b96-dec1e7c29269",
"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": "0623ddd5-dfc2-4dca-b319-89cbacb58a09",
"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": "ddb4de33-1717-42d6-9528-bc601df95bb0",
"db_country_code": "sample string 28",
"feelist_id": "55b5404f-f704-4c2a-954b-716c0a562f6d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "668abcfd-1b66-415b-a3e2-fc9c2074c9d4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f4fd42a8-3003-44c2-a5b7-3b83e386920a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-10T19:33:08.9905675+00:00",
"db_currency_id": "2d4518a0-5512-4b4e-8fda-6c475f43e710",
"db_currency_code": "sample string 10"
},
"company_type_id": "fdb0a162-2cd8-4eee-9b7e-3aa3d6ce3f43",
"company_type_name": "sample string 32",
"company_type": {
"id": "a4dbc46a-c437-4529-b3bc-b5ab2b6e284b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8091390f-a367-4d8c-bf90-215d355e9784",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d0e27ae0-1f46-42b0-ae08-29647959973c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1b975763-b446-429d-965d-ff4d8074f357",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0ccef606-c630-4e78-86ce-e1fb31593241",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "672024ef-5643-41e3-bd15-bb0f5db70d77",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-10T19:33:08.9905675+00:00"
},
"company_sector_id": "9e707248-8c4a-4b28-802b-83c7252dcce0",
"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": "d50f325c-e2ca-4f34-924c-3bef8289dd7a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b21fcd5b-4258-4378-8e73-749705405b63",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3439b979-708f-4bfd-9748-afaf259a88ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "f8d2b581-dd3a-4fd1-b386-8c3be950c420",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-10T19:33:08.9905675+00:00",
"id2": 60
},
"db_language_id": "56deadae-988b-497c-a130-aba607d80c4e",
"db_language_code": "sample string 7",
"db_title_id": "9cdfe874-67ca-481c-a410-2207fbf0ed43",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-10T19:33:08.9905675+00:00",
"create_date": "2026-09-10T19:33:08.9905675+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-09-10T19:33:08.9905675+00:00"
}