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": "d000931e-6a65-42b2-b56b-d69f506fcb33",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4711008b-b404-4de0-b41a-08c58f6a9584",
"company_code": "sample string 5",
"company": {
"id": "7660113c-2f4f-4d15-ac8c-6b899f04c977",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-04T21:55:18.6873579+00:00",
"sales_territory_id": "ca4136f2-e7f8-4df0-aa15-88a39abf1fb0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50a0cfdb-1d61-4719-b6e9-0b3d4c9011c6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd96f14a-db9e-45b3-82cd-25b1409b5d3a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1ac31d9-7f63-44ab-abf1-8078d83ebd15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4646e7d3-45a6-4569-b99a-31237892b7a2",
"db_currency_id": "71789beb-b037-4f7b-942e-7fd1d21fb01b",
"db_language_id": "77dcec60-db5d-474a-8417-58f386472aaa",
"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-08-04T21:55:18.6873579+00:00"
},
"modified_dateutc": "2026-08-04T21:55:18.6873579+00:00"
},
"marketing_segment_id": "ba0bd863-6fc5-49cf-b7c3-faaa0d798246",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0e48cc4-2c39-4469-91fe-6d29309f83d2",
"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": "13c17e94-6f8c-45f2-b8f7-723e1e07482d",
"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": "7c5ecf46-d62a-4ab6-97bc-7e9fd74bbb36",
"db_country_code": "sample string 28",
"feelist_id": "48518240-bdbe-4297-a475-4c0068777e6e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5df2e1c0-29f6-4d61-b6ad-c7471c9468bd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1ef1cec8-a0c8-45e8-8508-0ba2f0e5f29b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-04T21:55:18.6873579+00:00",
"db_currency_id": "35cc9283-a9cc-4a45-ad83-e35c816804ab",
"db_currency_code": "sample string 10"
},
"company_type_id": "a5970216-94d5-4e81-a050-f948f22b6103",
"company_type_name": "sample string 32",
"company_type": {
"id": "dca8e636-43f8-42f7-b3b4-16adc0aaf91f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb3ce382-350b-4770-936b-379290b05335",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e18aa63a-9bf6-401b-bf62-52e036b99303",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e38fb5d-ea19-4689-a688-3e58d91e146a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ca40dcec-e08c-4047-adf1-0e34233dd1e2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9a0c5053-b420-42e9-a6eb-24b94f365414",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-04T21:55:18.6873579+00:00"
},
"company_sector_id": "3b6f834f-0b52-4683-94d1-acda6927b306",
"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": "548ab3a8-85d2-4651-8bd1-96f89c2429aa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2476d07a-0c95-4c52-92bd-25966a4ee2c0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "28be9cd9-27b1-499a-bc28-325d88499aff",
"account_manager_user_code": "sample string 56",
"company_status_id": "8be3b8dc-1565-493a-9b8c-a0d157db1a51",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-04T21:55:18.6873579+00:00",
"id2": 60
},
"db_language_id": "8a7002db-ff38-4070-9a6a-5dfc017b5420",
"db_language_code": "sample string 7",
"db_title_id": "ed2f7490-2f76-457e-b8c5-5c783fe5ac31",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-04T21:55:18.6873579+00:00",
"create_date": "2026-08-04T21:55:18.6873579+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-08-04T21:55:18.6873579+00:00"
}