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": "1bfd7e5b-a275-4745-a2b3-9895e212b690",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eedeb6da-4a87-42d8-a9a9-f5f8492a0b15",
"company_code": "sample string 5",
"company": {
"id": "c3a5cbc0-72a4-46d5-924b-c395d296f2c9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-13T01:13:58.8728003+00:00",
"sales_territory_id": "be2a32ec-3a85-4fe2-abba-4b7ab85dc67b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "082423b0-5df6-4307-a669-f0a650150137",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d2a712d-83b3-48b8-86d0-3afcb30233ef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5f368f3b-9c2f-4d10-806c-dc941387327f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7442af3a-225d-4a88-b94f-787f845d343b",
"db_currency_id": "68e4b5c2-c630-4d36-96d1-5c157a153e9d",
"db_language_id": "0acd307f-36f3-499a-96a8-fe2032a45183",
"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": "2025-12-13T01:13:58.8884257+00:00"
},
"modified_dateutc": "2025-12-13T01:13:58.8884257+00:00"
},
"marketing_segment_id": "3487c3f0-b7ee-411f-a41d-825ebc3b799a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d00ada2f-c7ad-4a08-9994-a3eebea43f22",
"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": "931a2477-fcc1-4505-b00d-2901f158fb4d",
"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": "9c9a28bd-7b7f-4e1c-a8ef-34606d618c16",
"db_country_code": "sample string 28",
"feelist_id": "0dd6aed0-8304-4caf-b664-5dd1254280a7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "883da07a-9061-4a03-8759-348e692a31b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b993fac1-d98f-46dd-84ae-f8a60641578c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-13T01:13:58.8884257+00:00",
"db_currency_id": "22cdaf12-bdbb-4eab-8b93-3d30dae430f9",
"db_currency_code": "sample string 10"
},
"company_type_id": "4437afd6-4b89-45e8-ac9c-0434d1ec618b",
"company_type_name": "sample string 32",
"company_type": {
"id": "7b3662a6-409b-40e3-b9c8-087f6675b62a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5bdc45b-786e-4531-be47-15f17d847ee5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c6882564-fc68-4f12-877f-48a9b202dd74",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f19b7282-7596-47ae-8dd4-07c5127eae02",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "767e2e24-4088-411b-9111-7d43b944ed36",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "499749ad-5e94-4504-aebc-a6afdda312f5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-13T01:13:58.8884257+00:00"
},
"company_sector_id": "53464036-4197-4b36-a3aa-4e28d8f5789a",
"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": "0db3e052-2080-41f7-afb5-8a7344b8f2a9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1af3abcf-d38b-4f1c-8e52-44f36f90f23a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d5be62cf-3048-477c-b3f9-12be6e769850",
"account_manager_user_code": "sample string 56",
"company_status_id": "c2a62030-72aa-4482-b32b-aa4c86b9648b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-13T01:13:58.8884257+00:00",
"id2": 60
},
"db_language_id": "0f589245-03a1-4e99-a0bb-4591e124e28a",
"db_language_code": "sample string 7",
"db_title_id": "7a494004-5385-4c1f-978f-3b297e2b2789",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-13T01:13:58.8884257+00:00",
"create_date": "2025-12-13T01:13:58.8884257+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": "2025-12-13T01:13:58.8884257+00:00"
}