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": "4f900743-d6c4-42eb-8e6c-83a487e11010",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1ce46666-51f4-4e01-8b6d-2d29e17d5253",
"company_code": "sample string 5",
"company": {
"id": "17623788-d2d1-4206-b567-fe6768daf297",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-08T09:48:29.188883+00:00",
"sales_territory_id": "a47c2d3d-a2e0-4043-93d8-03d6cda552dc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "83cd54ee-d527-4beb-96fa-566c0328ed2e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc95588b-0ff5-4a72-8cea-2a0f5667a2de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "941b91ef-75a8-473d-9c2f-90cb238d58f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "494e7053-5656-4cc2-98a9-8e608a33f484",
"db_currency_id": "40f4aebc-0918-406c-9038-6133819463d1",
"db_language_id": "2e400dec-7c20-46d4-be65-3f54a813aa0c",
"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-10-08T09:48:29.188883+00:00"
},
"modified_dateutc": "2026-10-08T09:48:29.188883+00:00"
},
"marketing_segment_id": "32c2d292-1203-4b80-b339-1d897a32ecac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1612ee25-0dc5-4118-b847-ea6125da670b",
"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": "6f6e6277-f7ac-460b-9158-c417c4f7e688",
"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": "a58878b1-91de-44f6-bcba-8d8a4b971928",
"db_country_code": "sample string 28",
"feelist_id": "a895c060-c270-4766-8d49-f4dbd46f3bea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c75622d0-c032-43e6-ab07-0faa020ed9e8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "78f30904-e568-475b-a243-82707068b31b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-08T09:48:29.2074073+00:00",
"db_currency_id": "c1fb374f-f730-47d0-965f-054295b2b229",
"db_currency_code": "sample string 10"
},
"company_type_id": "75bf4790-5e55-4f0c-a006-888929565320",
"company_type_name": "sample string 32",
"company_type": {
"id": "665c4f08-6f8f-4987-b472-759d7d839bb9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4123a1ad-552d-45cc-b42f-f14ae1f84960",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f872883a-7ffa-4084-9d62-9232dfdea5ff",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7387ac76-be10-479d-be70-f81e8003d394",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ba1a75f4-583d-46f0-aec9-8a2dd7a9bab9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "86a0eb4f-c650-4f17-8a13-924b67e99540",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-08T09:48:29.2201333+00:00"
},
"company_sector_id": "497dbfdf-99ad-49e8-ba3c-b4652e013729",
"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": "fe792df2-befd-4b5f-b623-c61f592ae4b0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a1b64484-342e-4246-a8c2-107f2a7b1896",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "caf7fc9f-0c28-405c-99f8-646db5d14222",
"account_manager_user_code": "sample string 56",
"company_status_id": "0046aa2c-f1f6-4d38-aa27-89031fe9a8e3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-08T09:48:29.2368992+00:00",
"id2": 60
},
"db_language_id": "85875967-a4b2-4593-a7f6-bdc4e2130b58",
"db_language_code": "sample string 7",
"db_title_id": "346ecb14-38ea-458f-ac92-b12211a2144d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-08T09:48:29.2368992+00:00",
"create_date": "2026-10-08T09:48:29.2368992+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-10-08T09:48:29.2368992+00:00"
}