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": "7fa3898f-92e8-4f4b-9f44-be8e2d9172cf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7a92993b-e4be-4b7d-9a17-abfcd46a5792",
"company_code": "sample string 5",
"company": {
"id": "5853e4d7-98bd-4a73-a895-f63314927e12",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-26T11:24:06.6899902+00:00",
"sales_territory_id": "5a198e55-1457-4f8a-a004-9ae4d6db47ae",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ee9abb64-1afc-4a54-b0d3-cc7acb3c3083",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42ccfcba-ce44-464d-a7a7-7d3e531eda51",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "16d4d3ad-dafd-47ab-a63e-745ea2d16d1f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c99a77a8-f5a4-4b4a-a33f-ed7c34e20f34",
"db_currency_id": "6d1a6bc1-fce2-4318-ab12-9fa455c4d882",
"db_language_id": "89f8061d-bb17-47d5-9831-6e5ae5605091",
"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": "2025-06-26T11:24:06.6899902+00:00"
},
"modified_dateutc": "2025-06-26T11:24:06.6899902+00:00"
},
"marketing_segment_id": "f3e0f03a-5d97-4094-91c8-3b35fe847728",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c45c912b-1ba6-4af8-bb1c-bfe440b080d1",
"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": "ef6e9b4a-7750-447c-b874-1fe546d06022",
"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": "5c53f0b4-e033-42b4-a3fa-2137a256e09f",
"db_country_code": "sample string 28",
"feelist_id": "0a5a02fe-2413-4967-a4dd-f1a01c3d8435",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "46269be5-7779-412c-81ad-28cccdad4e0d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f7c4449a-973a-4375-aeaf-0d75d8efbe86",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-26T11:24:06.6899902+00:00",
"db_currency_id": "872090c7-8bba-4833-ae2b-0f502171d605",
"db_currency_code": "sample string 10"
},
"company_type_id": "72eb22de-169b-4bfe-9f10-3379cc1230dc",
"company_type_name": "sample string 32",
"company_type": {
"id": "4d7edb75-0c95-463f-bdee-673a36e23dc3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "064599b1-01f9-44ae-be66-c62438854d98",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6358efdd-2309-46bd-b619-b0236b160cee",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fcd439e8-cfdc-423a-825b-85342c29ebff",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e3746026-728c-4fdc-b1f4-89c39f60880a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "68d9d697-4c4f-4e43-af03-ffd16995556e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-26T11:24:06.6899902+00:00"
},
"company_sector_id": "fa0d54a0-cbc7-4097-a932-553aec9b041e",
"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": "03e3abf4-33e2-4417-ac7e-0e7218db8052",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ff2a8ff6-ee63-49a6-b67d-3dfcb2bc1d34",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "67789ded-4b1b-44ed-b49e-35d6a8f51998",
"account_manager_user_code": "sample string 56",
"company_status_id": "5e7cd92a-fdfe-4a22-b16a-f3bce1c2b748",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-26T11:24:06.6899902+00:00",
"id2": 60
},
"db_language_id": "6bbdf49e-bf1d-4554-8672-bdf630427bfe",
"db_language_code": "sample string 7",
"db_title_id": "5ebf088c-f6cd-433b-b55b-b6b4f4ca7a71",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-26T11:24:06.6899902+00:00",
"create_date": "2025-06-26T11:24:06.6899902+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": "2025-06-26T11:24:06.6899902+00:00"
}