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": "d28d427a-5cc0-4540-b4b2-5dc071415ec3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a5d5172e-01ed-4ca9-b2d0-eb5a980878c3",
"company_code": "sample string 5",
"company": {
"id": "8bc200c4-1232-43d0-ab7f-bcd53e639c19",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-21T09:30:15.2015008+00:00",
"sales_territory_id": "8eb4d6f4-8ec8-4771-8ee5-51921f9d942d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "62547bf0-5305-4346-b977-a995910ab3c5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae92e21f-1ff2-4fee-94cc-277728986aae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "42b4db44-c3f2-4230-866e-8fd6d28665f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "661d2052-cf79-47f6-8d98-c810199a3b85",
"db_currency_id": "64405087-0941-4247-bc3f-a25146a2aeab",
"db_language_id": "fc13c132-9273-4e0b-ab58-10b2f5bc1c41",
"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": "2025-12-21T09:30:15.2015008+00:00"
},
"modified_dateutc": "2025-12-21T09:30:15.2015008+00:00"
},
"marketing_segment_id": "b0156f26-6482-4c38-9917-6d27f3d01b55",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ef629082-a6b8-4eb6-9a4f-826c41eaa20d",
"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": "2b12b3cf-4cc8-40d7-b923-c3437616e007",
"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": "1ab0a1b4-2a77-43d9-af6a-d4cb44bb3d1e",
"db_country_code": "sample string 28",
"feelist_id": "56d7704a-43ea-49a8-8955-b8023db9bceb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1f90a4f1-3ade-40e3-8280-740af9f49f09",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "988f47dc-5904-42ba-ba35-3ebc285ff40b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-21T09:30:15.2015008+00:00",
"db_currency_id": "b5fc8f3d-60a3-44f7-b901-1e8f3d136967",
"db_currency_code": "sample string 10"
},
"company_type_id": "0b9e6ee1-3b04-459a-8730-52a4843062ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "b7114373-da86-4767-a8ac-99a90f3007d1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90a32290-38a9-499f-9c83-6a7f66463211",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f600df7a-588f-4693-b99e-5573a3a67df6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e89808ef-023a-4835-a09e-9d97e0024297",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "08160609-7132-4a93-92ab-1a6df51aec22",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a4024005-bf43-47d7-b138-69d50e88b862",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-21T09:30:15.2015008+00:00"
},
"company_sector_id": "8e721d83-1aa1-4e5b-9c82-8fecfd3e842d",
"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": "06ff434b-2546-4968-8222-253f5504f70a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "20d50740-8117-459a-aa49-8a14d6173648",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cbafb7ba-981f-4f81-9ee3-49f68f9a1a6d",
"account_manager_user_code": "sample string 56",
"company_status_id": "40d4fa3d-3640-4a09-a01e-ec7a7639fd1c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-21T09:30:15.2015008+00:00",
"id2": 60
},
"db_language_id": "5313a939-a8f8-4c83-bba3-dff3daba1ba6",
"db_language_code": "sample string 7",
"db_title_id": "0fd12ba5-2927-4356-b118-bd0d98fbe5a1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-21T09:30:15.2015008+00:00",
"create_date": "2025-12-21T09:30:15.2015008+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": "2025-12-21T09:30:15.2015008+00:00"
}