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": "dced29f6-8fc3-476e-bb3d-3af4fb6789d9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2d55a245-e0c9-445f-8b47-d1fa0e1f2573",
"company_code": "sample string 5",
"company": {
"id": "ebf52735-8245-45cb-938f-36add629bcb7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-18T03:17:20.7770053+00:00",
"sales_territory_id": "8bbff3cd-51fa-4b4c-b8f5-0b1670909f2e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "69044cda-2dd6-4dba-8a16-2a4234d927f4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "638d62c3-0dfc-46d5-a726-31655d5ad1ad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be9e9eae-dd76-4ccc-ab43-2659be6c74b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b24ae111-b4f1-427c-8515-442d68767b26",
"db_currency_id": "bb50628b-d0b9-40ae-9b06-9b96910e4c09",
"db_language_id": "20e23e9f-0b03-4b01-8d2b-28dbdf20c609",
"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-07-18T03:17:20.7770053+00:00"
},
"modified_dateutc": "2026-07-18T03:17:20.7770053+00:00"
},
"marketing_segment_id": "57a348ab-f77a-465c-ad20-1bd9e38b8131",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e86f22ef-384e-43d0-ab21-f81d19925de0",
"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": "0b34dfa9-dc12-4033-8381-302958e38361",
"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": "4e4287fa-e957-4191-8a98-00e125d47c1c",
"db_country_code": "sample string 28",
"feelist_id": "e0c3d575-942b-4c14-b9c0-e0efad7d3801",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "48ebfaee-57ee-4937-8d0b-b989542a49a9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dd122a7d-f172-44c3-ba6a-4adaac8852e6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-18T03:17:20.7770053+00:00",
"db_currency_id": "03054723-43f3-402c-8cae-c700b9f498d5",
"db_currency_code": "sample string 10"
},
"company_type_id": "81537c80-8c4e-4577-b844-29123b8861d5",
"company_type_name": "sample string 32",
"company_type": {
"id": "fad4f7f3-6b12-404b-af0a-1265a003da98",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7361c209-7b57-47a0-b76f-bd4c95cf0b0c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7e77e200-bff1-438c-9ea2-6dc3f347ca7e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d0387a58-2654-4bd4-a87b-3dd9d559fd4a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "06db0f6f-f6aa-4961-b43c-fcf7751cfc92",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b22e5c0d-1317-4536-bfa6-d5cc4da037fd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-18T03:17:20.7770053+00:00"
},
"company_sector_id": "e2208138-7df7-4072-8de6-96efe613d631",
"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": "4e15dc99-a6b4-4ce7-b050-6fd7ea3a6925",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "551e2aa4-b626-426d-9a45-35271f77e531",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "99034d78-e87c-433a-8e57-ed7b100cc222",
"account_manager_user_code": "sample string 56",
"company_status_id": "476e3346-bb8b-46da-9866-ed08e5228a0d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-18T03:17:20.7926288+00:00",
"id2": 60
},
"db_language_id": "f81d0ae9-ca83-4c7e-9c0d-0b662e86ca44",
"db_language_code": "sample string 7",
"db_title_id": "3dd08aab-e47c-4ed9-a9a2-640c273fdd26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-18T03:17:20.7926288+00:00",
"create_date": "2026-07-18T03:17:20.7926288+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-07-18T03:17:20.7926288+00:00"
}