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": "8a93b1bf-8510-4c4a-89d5-cf043c5b50ac",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c7b74b52-478f-45f6-bf42-988848f8905d",
"company_code": "sample string 5",
"company": {
"id": "75f8fc59-c92c-45df-8425-01a335fe53da",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-16T15:23:49.0693275+00:00",
"sales_territory_id": "f1b4b6cd-3b56-4a04-be5c-947e716f576a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ae4fc338-99b9-46a2-abf5-1369101c9b1b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81ef26fb-94a5-4374-9843-d4e2359fbeb6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd65ee4c-ba62-43ee-bced-917144dffa0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf5d715b-bd6f-4f79-a2a1-ee0776f7ddf1",
"db_currency_id": "14c47fb7-2c63-46dc-991a-37d44fbcada5",
"db_language_id": "2808eec9-7213-43f7-8dc9-a79f024416ab",
"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-01-16T15:23:49.0693275+00:00"
},
"modified_dateutc": "2026-01-16T15:23:49.0693275+00:00"
},
"marketing_segment_id": "e02671c2-542e-4d1a-88c6-a98209ef66c0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c69f8a49-e611-4a39-b2b2-97e479895ab0",
"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": "9811510e-8028-401d-8731-1ed91e3efd54",
"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": "8bd6edc5-9a40-4ccc-9740-688d054209a3",
"db_country_code": "sample string 28",
"feelist_id": "67b31a03-1b1e-4a0c-bc06-4ff09cf5de35",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e2a5e4c6-5b84-48c2-be43-66e2dcb07409",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "82e2ee26-134e-4cd3-a817-9cfe2f880f8e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-16T15:23:49.0849452+00:00",
"db_currency_id": "3a3a5b92-0cf3-4232-a787-c35b1e217720",
"db_currency_code": "sample string 10"
},
"company_type_id": "f6dd1741-b5d9-42e3-aa27-71a9b752faed",
"company_type_name": "sample string 32",
"company_type": {
"id": "7a33973a-a6b9-43dc-9b52-f5daa652c325",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0c9ac992-a7ac-46c5-9ef2-39aae5ca2afd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3e475363-93ae-4a93-8455-0f875f7ef70f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5fffcd3e-d3d9-4245-85b8-e29968d81cb7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dc78081f-513d-4bcf-8bf2-20a57ea384df",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "84d3ea9a-2b02-4ceb-99fb-4d8178eb9322",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-16T15:23:49.0849452+00:00"
},
"company_sector_id": "848f7ba2-75f5-42a7-9fd8-53a9dbb2b9e8",
"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": "1b007f04-579c-4c63-adb7-4aafdbfedc67",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f9cb469a-2521-4168-9855-d11220b75537",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aa53a9e2-a007-45f8-81b6-be09a6dbc489",
"account_manager_user_code": "sample string 56",
"company_status_id": "78250ccf-d903-45a6-9b09-28819d07de97",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-16T15:23:49.0849452+00:00",
"id2": 60
},
"db_language_id": "13bcaa73-676e-4fe5-96a5-7c0bd500520b",
"db_language_code": "sample string 7",
"db_title_id": "d6b74994-18e5-4395-b6f0-36c5ad570e28",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-16T15:23:49.0849452+00:00",
"create_date": "2026-01-16T15:23:49.0849452+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-01-16T15:23:49.0849452+00:00"
}