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": "098de86f-11b1-4aae-92b7-9bb5b4fcd6ec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4128a5d0-771a-4eb7-8730-a36da09e2c9f",
"company_code": "sample string 5",
"company": {
"id": "7b29cd1b-9556-4f41-900c-c9f6021d5a4c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-04T06:17:09.7745716+00:00",
"sales_territory_id": "0910a776-2e0b-46b0-a734-0ef8cc5ff8b7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e5fdcf2a-6049-494a-9b51-4040d796b976",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "be3475f6-4971-4d64-8cce-fb282af8e6d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "46db33b1-0950-4606-af72-f241c6a5cbc6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a965cec1-393c-4aa3-b746-d6bf5798d062",
"db_currency_id": "11cdefef-e71f-4231-8ec9-0d772d9a8d2f",
"db_language_id": "29718896-a43c-45be-87fd-7ca638a5c811",
"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-04-04T06:17:09.7745716+00:00"
},
"modified_dateutc": "2026-04-04T06:17:09.7745716+00:00"
},
"marketing_segment_id": "5c95ea23-cb16-48b4-ab30-074a337323a6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6553dce1-11e2-4b4e-b837-71bb72add833",
"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": "336ede7c-50bb-4207-bd85-735859422c4a",
"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": "fcdd1e70-35fb-45ab-a2b4-fc7cd3ca7f69",
"db_country_code": "sample string 28",
"feelist_id": "2220b7db-8605-46c3-850b-03202cbe68a1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "df92885a-cc77-4c10-a6e8-009a594af92f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6f534296-6cfd-48dc-9107-54914cbb8a2d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-04T06:17:09.7745716+00:00",
"db_currency_id": "b79f15dd-0b14-46d1-951b-12342743fa2c",
"db_currency_code": "sample string 10"
},
"company_type_id": "95bbca7a-d919-4c22-a068-137533c0bf12",
"company_type_name": "sample string 32",
"company_type": {
"id": "eca215e2-99fa-4ef3-8122-b0bdd570520a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2b346a60-1531-4a56-95c8-eb638d14b8e7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c866d9b0-1c56-4b98-9d9f-e7f50e24043e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c04f7739-9472-4066-9035-8ea682bc88af",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b2c751c9-a82a-474b-bb7a-19a5f77e5a16",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "40244832-2ec3-4dc7-98e1-cd093cc6ab4a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-04T06:17:09.7745716+00:00"
},
"company_sector_id": "5821c1a7-801d-46e2-a6eb-9b9caeafed90",
"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": "bd49b7ca-48f6-4161-8658-c61634302f0b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2de1f6ea-aaee-4c0c-a0b0-01d6dea056d0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ca27918d-caee-42ef-b0e1-7622de65503d",
"account_manager_user_code": "sample string 56",
"company_status_id": "a9303dcc-6547-476b-9732-3eb02f45d8bb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-04T06:17:09.7745716+00:00",
"id2": 60
},
"db_language_id": "0a6a2ada-f9c8-4dcd-9836-c21d4df8b50f",
"db_language_code": "sample string 7",
"db_title_id": "1969d763-2384-42de-8919-d45bed780131",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-04T06:17:09.7745716+00:00",
"create_date": "2026-04-04T06:17:09.7745716+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-04-04T06:17:09.7745716+00:00"
}