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": "17731e2e-cbf2-44e2-bd89-a46cc9153d21",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6d294cc2-e51c-440d-ab73-275e71d06a96",
"company_code": "sample string 5",
"company": {
"id": "b98985df-91ba-466a-8dc1-541e62f0add0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-13T17:35:49.997396+00:00",
"sales_territory_id": "1854432d-a63d-4ce6-9cb4-25f5a2607980",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c77d68a1-5649-4e7a-86cd-aa1309dd0c5b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b9c8b61e-097f-4ac4-8d60-c01d05c706ff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ebfcf616-6d26-4f63-a9fc-df0334bcc75b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9fbe85d-3cd9-4093-882d-275aa2004053",
"db_currency_id": "3727baca-3672-47e3-ac17-c181a0d612b6",
"db_language_id": "f51950a0-c428-4898-9d86-1a7d9ca39011",
"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-11-13T17:35:49.997396+00:00"
},
"modified_dateutc": "2025-11-13T17:35:49.997396+00:00"
},
"marketing_segment_id": "732d88ba-c88f-4fef-be72-079693b8db11",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1120357b-9336-49bf-b953-9e6b4f01e0ff",
"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": "79723a31-522e-4783-94d6-982bf6b78d81",
"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": "f7bfad67-b4c6-4ac5-a3b1-fd11f285e839",
"db_country_code": "sample string 28",
"feelist_id": "390fde9a-8a15-4fc1-937b-45d8103cfb83",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5e7cbd16-f46a-4ccc-9dd9-2f3d21686b43",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a9528c5-4fec-4300-9e1a-48b6c2a7ba6a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-13T17:35:49.997396+00:00",
"db_currency_id": "ea7afdbe-30b3-47fc-8584-9b8e491ab474",
"db_currency_code": "sample string 10"
},
"company_type_id": "243cfdf0-2b6a-4d30-8293-251d39b63f6f",
"company_type_name": "sample string 32",
"company_type": {
"id": "cd5ba628-74ad-486e-a056-85ea7e464cdd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "abc31117-56f8-43a0-b5a3-6e56dab4f8d8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3969efa4-3b4a-44df-9116-d47871ce7264",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dd0053b2-c734-480c-ba9d-70a0f28d5560",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "72b2b247-733d-46fe-a48c-68fa52e8632a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "422f4e60-10a5-42a7-909a-1939dfbfff6e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-13T17:35:49.997396+00:00"
},
"company_sector_id": "47815601-2564-4fad-ae54-107e5095a578",
"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": "c79ebfe8-fb7f-478e-b5a6-c6cf480a9969",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7345bbe3-f69d-492a-b91e-20ab871d296c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "24bae49e-a34a-4fcd-8c05-eeab81b02a09",
"account_manager_user_code": "sample string 56",
"company_status_id": "c70ea2b1-33e9-48f8-bb24-6cc5095a0427",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-13T17:35:49.997396+00:00",
"id2": 60
},
"db_language_id": "6c4e84fc-5d61-4360-aed1-be1bf9ab4080",
"db_language_code": "sample string 7",
"db_title_id": "112cfbe0-155e-4396-8f01-090d6784e9eb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-13T17:35:50.0130201+00:00",
"create_date": "2025-11-13T17:35:50.0130201+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-11-13T17:35:50.0130201+00:00"
}