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": "757aec58-c76e-4eab-8d2d-ae6591b4c59e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "86fcde92-6fa0-46fc-b897-9ee26fd491a3",
"company_code": "sample string 5",
"company": {
"id": "f6dcc5dc-0cee-4bb5-add6-b96d4b97549c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-01T00:27:38.2716323+00:00",
"sales_territory_id": "7fcbbe42-4c78-4c2e-a14f-fdca607b3b23",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6c9a5ca6-ad6d-4e2f-92c8-e9b14d7b6805",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2bc2d3e9-f629-4860-b996-58839aaddb9b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4757f99-1537-4fc3-b979-ba69d1d93188",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b9c71a-d81d-4b47-890a-8d1661d214a6",
"db_currency_id": "a7779a05-14df-4750-ab21-10a86b274416",
"db_language_id": "7a5d595a-ad50-431a-84b2-753e48fc2cac",
"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-06-01T00:27:38.2716323+00:00"
},
"modified_dateutc": "2025-06-01T00:27:38.2716323+00:00"
},
"marketing_segment_id": "3204d665-ac33-4c5e-9ef6-e309644b69c4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5f51e19f-5c3e-4864-a26d-61bfe57db6bc",
"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": "ef7090c3-dd4e-464d-80ef-e28f6d715e73",
"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": "0451753c-9289-48da-836d-8f112b45c93b",
"db_country_code": "sample string 28",
"feelist_id": "900b3e58-a17a-461e-b08e-c31909c4a00e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4451ccdf-a62c-4e24-89d0-ef865c79618a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "699a4d29-59fe-4872-962e-7de536121147",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-01T00:27:38.2868772+00:00",
"db_currency_id": "0521eb68-4307-441f-b24d-aa72b1800464",
"db_currency_code": "sample string 10"
},
"company_type_id": "81588825-ec0d-4de9-8987-df178707b8eb",
"company_type_name": "sample string 32",
"company_type": {
"id": "198c10d1-e420-44e3-892a-79307838f5a9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e9e588ac-3db1-4644-8d31-b933c9537d8d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af5aad7b-d875-4cb6-9b98-453a1c2648ad",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fcbec67f-61c0-4aa9-a210-0c4c81f658e3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "639d6b1d-db97-4699-8dc5-9fae835d50aa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "13e4a998-aa55-4106-a36d-06eb757f7899",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-01T00:27:38.2868772+00:00"
},
"company_sector_id": "ce02a815-9d16-461a-b5ff-540e4b9f626c",
"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": "86aafb4d-4bbd-4582-8d65-1ceee6000ec7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4c664c16-d1e4-45ad-afdf-78a1c8933d9e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "813ca636-3f93-44f3-8a94-5333a7331393",
"account_manager_user_code": "sample string 56",
"company_status_id": "b5a98283-1b1e-401f-a733-5ef700d9d91d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-01T00:27:38.2868772+00:00",
"id2": 60
},
"db_language_id": "c02b9179-aba1-44ad-8f68-3c1bb722c5a4",
"db_language_code": "sample string 7",
"db_title_id": "41ca61b1-e62d-411c-adc6-81c745ed8ba7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-01T00:27:38.2868772+00:00",
"create_date": "2025-06-01T00:27:38.2868772+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-06-01T00:27:38.2868772+00:00"
}