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": "27e89f82-8452-4259-b818-c6a8d2f05534",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c1ea75bd-cb9c-4073-b6ff-ae922ca9719b",
"company_code": "sample string 5",
"company": {
"id": "01b8d19e-9c5d-4def-94de-75f7c896660e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-12T00:30:00.4364279+00:00",
"sales_territory_id": "d1bb7c2c-b7be-429a-81b4-6cbddf903cd2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aabc33bf-2de0-4c59-acc0-e048b5efbd76",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30fd4227-662f-45c4-bb74-5f35eae979df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "761d2d1b-34dd-42d0-8ec3-0a8e9a4054ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f09c53d-a8df-454c-b379-f6acb6af8bce",
"db_currency_id": "161e2070-ba1e-4bf8-a9e3-333b72da093a",
"db_language_id": "f0f3293a-657e-4a88-a8f4-5d0721f75c18",
"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-07-12T00:30:00.4364279+00:00"
},
"modified_dateutc": "2026-07-12T00:30:00.4364279+00:00"
},
"marketing_segment_id": "4f325640-bf6a-468b-9503-fc2387abee24",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3d4d9380-d90d-4e48-a505-661e532d623d",
"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": "7423c46d-6d60-4bf4-a086-00d51ddec349",
"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": "cfb0f33a-fca1-4431-a381-549ef20f45f9",
"db_country_code": "sample string 28",
"feelist_id": "c88f251e-f0d8-4506-a6b7-029d16178f32",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "043d7853-0756-404b-860e-8043e8bdd306",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "860ebf2a-5d6c-49da-8e69-7e284876d7a4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-12T00:30:00.4364279+00:00",
"db_currency_id": "ec527c8d-0c63-4d37-9d6a-1424a524be81",
"db_currency_code": "sample string 10"
},
"company_type_id": "7f227773-597a-4623-a027-2e76234f184e",
"company_type_name": "sample string 32",
"company_type": {
"id": "c7dcbbad-726b-461c-9758-7ffff243be0c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e63cced2-a5f0-4e5b-863d-a8616f383249",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4ec9534e-3a23-4567-b5cc-08476badd61d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "11c0d2f1-74f0-4ea6-b3c4-50e171d68adc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "84d1037c-b37b-4cc8-a679-ae5879971537",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "20b26b1f-42c1-401b-b753-f07ff34e6504",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-12T00:30:00.4364279+00:00"
},
"company_sector_id": "b1821acd-253b-4c4c-a245-f49ee85d3ca0",
"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": "669414ca-3253-4add-a141-375a44ec801b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fd14b2be-6e98-4b6c-8a6f-cbba04872e68",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "285f72dd-0657-4eb3-8a59-e9a0726a7071",
"account_manager_user_code": "sample string 56",
"company_status_id": "84f72127-5660-46fb-8f96-0cc25492d996",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-12T00:30:00.4364279+00:00",
"id2": 60
},
"db_language_id": "1681d553-18ed-4858-867c-2f660c69f7f5",
"db_language_code": "sample string 7",
"db_title_id": "d068aa24-c1c3-4f95-b87d-f3af83dab5d1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-12T00:30:00.4364279+00:00",
"create_date": "2026-07-12T00:30:00.4364279+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-07-12T00:30:00.4364279+00:00"
}