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": "d0aba115-6b1d-418b-941f-8106d9c33081",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f6fd4c9e-49e5-44d3-a1f1-107961bda1bb",
"company_code": "sample string 5",
"company": {
"id": "04b307c3-23e7-4966-999e-b804860bcc1e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-23T20:23:19.5210695+00:00",
"sales_territory_id": "1a38b6bc-810a-446f-bbb2-b391a6c5a7ca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7f8e8a45-a01d-4d30-b874-1bf3ec9231c6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c118240f-5409-4e8c-ae98-df26e76153dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8622f70e-fad3-4697-85bc-73cd1bf5808c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5461f338-b62a-4f0e-b07f-38238345bbc4",
"db_currency_id": "ceea0290-50c7-4d22-9188-9c48cf134edf",
"db_language_id": "b23d24f6-6773-4c5f-a49e-f8bf41206cc5",
"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-03-23T20:23:19.5210695+00:00"
},
"modified_dateutc": "2025-03-23T20:23:19.5210695+00:00"
},
"marketing_segment_id": "c1083d6b-50cd-494d-823d-b5eaa4baf060",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "464660d3-fb3a-4a2e-a147-96f6551bcb11",
"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": "408bb09b-6b53-409b-96a5-461d43b08ff6",
"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": "401a09bc-4eb0-43f6-a532-a5f9ca4f2018",
"db_country_code": "sample string 28",
"feelist_id": "987f554a-3045-4581-b9e8-61bf51c11aa5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1859f56b-b56c-4245-a86f-004f6e15b1a3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "145d4fae-efb2-45b8-92a8-cf97e8ead44d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-23T20:23:19.5210695+00:00",
"db_currency_id": "f8f114c5-0cd1-45b8-abdf-5d67e378bdc3",
"db_currency_code": "sample string 10"
},
"company_type_id": "06ac705e-5832-4399-8318-2c7a9f95d277",
"company_type_name": "sample string 32",
"company_type": {
"id": "e73596ff-1ebd-4113-9f15-95c3c8d0d0a2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e1a2054d-4d25-4021-a039-ef384472eea0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c131709a-505b-4794-8a12-218252cfc074",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "de6fd83a-92e8-48db-9c2f-d912222327fe",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6d747a87-dd69-42f7-9469-4cb724462c05",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9158124a-ff02-40e1-93b8-acdcf7302d08",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-23T20:23:19.5210695+00:00"
},
"company_sector_id": "a1383640-84ac-422d-9e2a-5cac2bfbd482",
"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": "416b02d8-13b9-4059-a545-68d68e06b441",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "86aa178f-d8a0-4978-85b2-4706d43d0157",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b43906a6-0287-422d-b661-44a96bab38f9",
"account_manager_user_code": "sample string 56",
"company_status_id": "48d762f1-ad8f-43e1-8505-614e42905d0b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-23T20:23:19.5210695+00:00",
"id2": 60
},
"db_language_id": "e330cbb9-d746-4eac-9fd2-4dcaa566aae5",
"db_language_code": "sample string 7",
"db_title_id": "76afa0a2-d6b3-47aa-a7ff-09909199d2a7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-23T20:23:19.5210695+00:00",
"create_date": "2025-03-23T20:23:19.5210695+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-03-23T20:23:19.5210695+00:00"
}