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": "a5449789-f418-49ff-90bd-c3946ad7aadd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f6657c2e-8282-463f-80aa-cd8f0a6265f8",
"company_code": "sample string 5",
"company": {
"id": "993bda79-97f4-46e0-bc97-06bc643d0be0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-04T22:02:45.677202+00:00",
"sales_territory_id": "40b6b9d7-6344-4e31-a0d9-230d02623cd5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bd59a9db-ed09-491b-ac24-4d9c377d6704",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "32843ffa-b28f-459e-b1ca-b12d48b174ff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9b0ceeb1-6f03-4396-8aaa-0b2e07feb813",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "584c445b-d530-4447-9c65-f098711f981f",
"db_currency_id": "e516582d-7d98-402f-a2ef-b1dd8b17612c",
"db_language_id": "598eb453-e121-4284-a1dd-84855b519e0b",
"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-04T22:02:45.677202+00:00"
},
"modified_dateutc": "2026-09-04T22:02:45.677202+00:00"
},
"marketing_segment_id": "4330fd65-ec45-4ec5-83f3-d12474e961e2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3639ec85-7fc7-4dc3-a602-74d59406790b",
"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": "9141a158-9e8d-495f-8555-26b5adb14256",
"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": "753b5240-d80c-4d9a-9afc-73f652846bc6",
"db_country_code": "sample string 28",
"feelist_id": "6cfd9788-da31-4b33-bbc0-278e050caad0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ec85bc65-8468-49a9-ae1f-83e92a39f6a7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ec6c694c-16b3-4cd3-8ebf-42c2e800c53d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-04T22:02:45.677202+00:00",
"db_currency_id": "2e17c845-3ad3-40c9-9b09-06261be634ae",
"db_currency_code": "sample string 10"
},
"company_type_id": "6171f247-de1d-4001-a94a-ab135e125ab5",
"company_type_name": "sample string 32",
"company_type": {
"id": "0f7e4479-f828-420a-a1d6-9051a1f353f5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7bef371d-a229-450d-9d04-474bc25c3eb8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1f1f8df2-be4d-4a02-95fc-360389cde63f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1f247b51-88f9-4664-8cff-ddf20525ce62",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "045f1f3b-6341-4841-bdb7-09c5eb12130d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2cb1fc87-5f78-4a1b-8c3c-0d8d7c59bc86",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-04T22:02:45.677202+00:00"
},
"company_sector_id": "21d67649-5329-4e6d-beee-ce395973a563",
"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": "53ed0572-6479-44bc-a7e5-d120447bceb0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "215626e1-cb2c-4b5b-9fb6-231f556e8f06",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9d0b5710-c39b-47c8-ab9f-597f9315c6a1",
"account_manager_user_code": "sample string 56",
"company_status_id": "b29d7076-69b5-480f-8a54-c911f1472130",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-04T22:02:45.6928241+00:00",
"id2": 60
},
"db_language_id": "575ab55b-73d4-424b-a91e-11704c0bf741",
"db_language_code": "sample string 7",
"db_title_id": "5b979197-0a52-4cce-b952-02e921f7caf7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-04T22:02:45.6928241+00:00",
"create_date": "2026-09-04T22:02:45.6928241+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-04T22:02:45.6928241+00:00"
}