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": "78878658-9468-45c3-8ce6-3c4105d05bc4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3fc9b526-f8b0-4337-b113-aa406c5ce917",
"company_code": "sample string 5",
"company": {
"id": "ac292660-efa7-4020-baba-3e067d6af048",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-17T05:57:15.3400755+00:00",
"sales_territory_id": "d253c4e7-816e-429f-917b-cfae1519d044",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "58c5ea88-db5d-4bfd-a9e9-afc886e5546e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30e0692e-481d-4147-954e-7958b0ea0ffc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5137ff3-d230-48b0-8301-5cbec8238467",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f315bdea-1fcf-4602-8069-6fb88306ff68",
"db_currency_id": "241f4997-41ca-43b0-a780-db52e5604a92",
"db_language_id": "d3e2066f-fa43-4bb0-a47d-f6a7a2cf28ae",
"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-06-17T05:57:15.3400755+00:00"
},
"modified_dateutc": "2026-06-17T05:57:15.3400755+00:00"
},
"marketing_segment_id": "400991e3-2a39-4724-a019-32a01bfc115e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c1a91291-77b9-4063-8e01-35f8b1d86dc8",
"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": "1cb49c40-921b-43c3-8554-283b689b1c81",
"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": "d27288a7-fc6d-4198-b13b-924c77bd4c70",
"db_country_code": "sample string 28",
"feelist_id": "2542f478-957b-4d18-bfae-142ed543cb02",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e46c27b4-df50-4f0d-ae98-697d17a76fb7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7e1b2522-f654-4d75-a23c-5d41696debae",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-17T05:57:15.3400755+00:00",
"db_currency_id": "d9387d8e-bbae-44ba-ab7f-59c22b2fe380",
"db_currency_code": "sample string 10"
},
"company_type_id": "b5586a7c-5f8e-488c-9c09-8290ebc97429",
"company_type_name": "sample string 32",
"company_type": {
"id": "2ed96a96-97e2-4a89-9d23-8d9bc71b1c8f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8200304-d978-4aef-acb5-a893601905f4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "54fdfeb5-6587-4cb1-8a55-a29c92ad6292",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0c3ce1bb-adb3-4711-8984-4ec23b3890a4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7e7bc44f-6076-47c4-968b-5bfddff4225a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "403fb2d9-fabe-42e7-916c-df0711061c80",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-17T05:57:15.3400755+00:00"
},
"company_sector_id": "8c2e5a60-6d45-4bcd-b240-4ad2db6a46f7",
"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": "5aa10ce7-1c74-4774-b12c-53cb0c53bcf8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1a9fcc20-14ad-41b1-8778-fb387d34288d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0827115e-5f61-4652-adb0-8a47ec4693b6",
"account_manager_user_code": "sample string 56",
"company_status_id": "a127d926-f8b1-4628-ad34-6e96c2826a60",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-17T05:57:15.3400755+00:00",
"id2": 60
},
"db_language_id": "7ab12a4e-ff8d-493c-b05e-4a5a4b5fd71a",
"db_language_code": "sample string 7",
"db_title_id": "5d497566-c71a-4c67-a7f3-8e593946b5f0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-17T05:57:15.3400755+00:00",
"create_date": "2026-06-17T05:57:15.3400755+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-06-17T05:57:15.3400755+00:00"
}