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": "196bde8d-b155-4b77-91e5-adbac2d7541c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1f5f99cd-f77f-4781-8b7b-673dc2b8debf",
"company_code": "sample string 5",
"company": {
"id": "40c606c0-3bb6-4409-b115-613f472a6841",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-23T12:03:33.2254468+00:00",
"sales_territory_id": "d6667810-3085-46b3-97a8-be244c2634a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5db56404-f108-4b3c-9791-bec2472cac1e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7176946c-284d-40c3-b0bd-a14d05752fe6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bafa2146-4333-4c5d-a311-e7a466c234e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "924238ac-8900-45a4-8a4b-7b977d2f9607",
"db_currency_id": "fda0ac6d-4870-4507-b238-26abae925cd7",
"db_language_id": "2c415566-a0a4-4d8a-ba2a-654c92d90e0a",
"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-04-23T12:03:33.2254468+00:00"
},
"modified_dateutc": "2026-04-23T12:03:33.2254468+00:00"
},
"marketing_segment_id": "e369b293-37cc-49e4-8470-f2e2cfd1f47b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4a7f24d4-1d3e-40eb-9264-630c96c4339e",
"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": "d5ed16ac-f4e7-4a27-b1ec-8c42227e5b1a",
"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": "f61d1116-479c-4dad-871a-e6d1f1758c09",
"db_country_code": "sample string 28",
"feelist_id": "07f33293-4d6d-4b3f-9417-aab5040b5e97",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0ddfb8de-2067-44f4-9837-1565e9ca7f31",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "84e77ea1-3256-4718-9893-5ac94614b066",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-23T12:03:33.2254468+00:00",
"db_currency_id": "0fddbc56-14f4-4429-8eb8-60afd8a74eca",
"db_currency_code": "sample string 10"
},
"company_type_id": "d35c7a7f-21ea-4ea5-9985-9d5b8a336c85",
"company_type_name": "sample string 32",
"company_type": {
"id": "9d6c7bd9-1910-4b69-8b59-dc3a70d7d037",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4fb8ccf6-0e8f-46a5-b58d-f0a531a53f09",
"sales_organization_code": "sample string 5"
},
"db_language_id": "90b5e6c3-8458-44fa-af70-5d4252f9a306",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "10dafd71-1cc5-4ed1-bd19-4021ffc10d8f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71d2f696-c935-446c-8902-7ed9a8841afa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "81e461a9-8ca0-422e-b984-db47302b11d2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-23T12:03:33.2254468+00:00"
},
"company_sector_id": "8bc87dbd-8684-4e61-86be-b2f495c56821",
"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": "4c2a27d0-f347-46c7-8f24-bc552d7089fb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9ddfdf8e-4b45-4c3d-9a7f-23cf28a7a919",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7ae40c8e-4fee-47be-a089-c60105140928",
"account_manager_user_code": "sample string 56",
"company_status_id": "54746553-c544-40f4-81ff-8af329cb7c3f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-23T12:03:33.2254468+00:00",
"id2": 60
},
"db_language_id": "5e717d9e-9c76-45fc-8688-1cf582a59836",
"db_language_code": "sample string 7",
"db_title_id": "301dfe41-8dce-4809-b31c-7b20820a6669",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-23T12:03:33.2254468+00:00",
"create_date": "2026-04-23T12:03:33.2254468+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-04-23T12:03:33.2254468+00:00"
}