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": "99f33c75-c497-40a2-931f-13e11a6616a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9605f206-c94b-4abe-b68a-0249f20fcdea",
"company_code": "sample string 5",
"company": {
"id": "28ac8454-b8e0-47d1-a1ff-1d0d53a0706d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-01T16:50:27.0054028+00:00",
"sales_territory_id": "dbf908fc-6112-4ae0-9a5a-1afbee8f8564",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4d163104-3a66-45be-8d26-9ec5720b3a0e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4e72789e-3901-49a4-80d9-949029d9d4de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b815549e-2bd0-492b-8c84-283496c2dcc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe26c907-09b1-4fe7-9393-9aea87541ca9",
"db_currency_id": "419e2f9e-688e-4cbe-a3ef-809dd77c9a93",
"db_language_id": "5a4a02c7-28b8-4415-b025-933f2d646ff0",
"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-09-01T16:50:27.0054028+00:00"
},
"modified_dateutc": "2026-09-01T16:50:27.0054028+00:00"
},
"marketing_segment_id": "658c935a-29e4-4da8-a397-317e5e7627e3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aeb4abed-9252-4df4-8204-6a326e206654",
"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": "eb90da20-b34a-43a7-bc43-167679e3b791",
"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": "d2721a4b-9e54-4a09-b94e-1444b07e5ff7",
"db_country_code": "sample string 28",
"feelist_id": "6bb6cdfe-c511-4c2b-afde-cbb38eeb6989",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9c998486-875c-4f55-9ff3-418090ea0e9b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "be65e300-5a2a-4099-9598-5318a5a45001",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-01T16:50:27.0054028+00:00",
"db_currency_id": "f8d585a4-a0fb-4b40-8322-40bc7f8a4cb6",
"db_currency_code": "sample string 10"
},
"company_type_id": "02b11a46-3441-47ee-a57f-38b5d0d07f1b",
"company_type_name": "sample string 32",
"company_type": {
"id": "245e49da-1768-4dd8-8bfb-5aa0ec9eeae9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c7048ecb-fe49-4b85-8c1c-1106e476b5f0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3a0c398c-4698-409d-957a-2fcb3508ae58",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d9469d38-f46a-4ed3-bc7e-513d514abec1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b15c4f02-bafc-4666-986f-266b232cc689",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a7d008b8-c789-450a-9a03-cf66497fe3d8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-01T16:50:27.0054028+00:00"
},
"company_sector_id": "cfbabf4c-fd16-49c5-ba50-7305318e3429",
"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": "9f394f0e-8e58-48cd-b1e5-597ccf73b747",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b84ad38a-44b5-4309-a3c6-0c278151ad71",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "031f0ca2-ee2a-4ea0-85ec-20fccf40e00b",
"account_manager_user_code": "sample string 56",
"company_status_id": "56c58802-a8a8-4109-8a57-1fe87c10b355",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-01T16:50:27.0054028+00:00",
"id2": 60
},
"db_language_id": "096c15cb-5ce3-48b1-a1f1-fe953b9aada1",
"db_language_code": "sample string 7",
"db_title_id": "0367869f-1490-41b8-8ff2-3ec17c0495b9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-01T16:50:27.0054028+00:00",
"create_date": "2026-09-01T16:50:27.0054028+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-09-01T16:50:27.0054028+00:00"
}