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": "8bcd6d21-5bbb-4340-bfc4-524ce76bcc9e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0650ca3e-41b3-4faf-95d7-40aa0fc6c7e2",
"company_code": "sample string 5",
"company": {
"id": "12ff9b76-cab1-4d3e-becd-87f63ee5e13a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:48:35.731702+00:00",
"sales_territory_id": "8aaa07b7-fdf9-4ba7-8e88-9b77cbbedf9b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bfdd063b-9c8f-423e-b3a0-796701d872db",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3afff636-9965-46a2-998d-0d007856855d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b87d3b61-a3f4-4825-aa7c-1a00c5cdfc0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6df7c4bd-939f-47b9-bfc8-951e6d8b914e",
"db_currency_id": "957d4a2a-2edd-4e09-9568-6cb7f28b17a3",
"db_language_id": "8f17f07d-e7ef-4ade-a0f3-51d54bab366d",
"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-02T03:48:35.731702+00:00"
},
"modified_dateutc": "2026-06-02T03:48:35.731702+00:00"
},
"marketing_segment_id": "0621fa7d-078f-44c1-8a1e-1e54317b902f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "19529c13-4150-4a46-9a3e-aca91ae995f8",
"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": "4d98cc4a-76e7-4ab7-aa99-483af6a5b463",
"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": "8911aed3-5eec-402c-a56b-2af04045fa2c",
"db_country_code": "sample string 28",
"feelist_id": "8566464b-dff2-463a-b1b0-732aa6ce9275",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cbd7a9ef-6a93-4aa9-adaf-89bc0a3322f8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f890f9dc-af09-4dc4-a5b2-fd72af4bcca6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:48:35.731702+00:00",
"db_currency_id": "bc18eefa-66ae-4162-8d5c-bf6859f24178",
"db_currency_code": "sample string 10"
},
"company_type_id": "5474b9e1-fcdc-4866-9755-854235a48ae7",
"company_type_name": "sample string 32",
"company_type": {
"id": "3d78de5f-5df8-4cc7-adf4-7b2f99acc03a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "743a61a0-b7af-4138-a22b-632e74831fd0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5dfda2d4-8005-414a-8d4c-48e5c85e5731",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e48488f-136a-4cea-8265-f1a76021a00f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "47f128d7-a582-42e8-82f2-a141739fd4ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5cadfd29-ae4d-4578-9e74-1a3161bb1196",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:48:35.731702+00:00"
},
"company_sector_id": "7708e1cb-b577-4b0b-a8a3-34932ace09dc",
"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": "5657709e-e8f7-4b51-960e-d9b4bed5c224",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "378f7346-bbde-4ef3-8731-382e2ed7b582",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8f99b370-3947-4eb8-bfe7-7e91f2d9a12c",
"account_manager_user_code": "sample string 56",
"company_status_id": "260d88d4-5436-4420-ae54-236b259f76bb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:48:35.731702+00:00",
"id2": 60
},
"db_language_id": "21f7520d-958f-4be6-be7f-67f04adfc0ae",
"db_language_code": "sample string 7",
"db_title_id": "76bb79c8-f379-4ea6-bfa7-1f551fe98a86",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:48:35.731702+00:00",
"create_date": "2026-06-02T03:48:35.731702+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-02T03:48:35.731702+00:00"
}