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": "d28a8f12-fbb4-478e-9402-cf8ed3e5333c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "30e47db3-a268-4ba7-8a64-346bca782387",
"company_code": "sample string 5",
"company": {
"id": "887db04b-27e8-4011-a5ae-1b42ba9729f7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-11T04:45:25.0825201+00:00",
"sales_territory_id": "3da0b31e-951c-4ce7-9228-d45e2e45f185",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c461d1b9-d5aa-45ad-836d-2bffa47610b6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f08f3a3-6367-4ef3-a846-123599c711e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "00ff5012-71e2-4cc5-91b0-49ebed022bec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7bdecd2-99cc-4ed4-a108-5184bdfa48a0",
"db_currency_id": "19c7f18f-7c30-47ad-aa41-6cf329402853",
"db_language_id": "ddaab675-db60-4f22-a030-2c562393d162",
"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-02-11T04:45:25.0825201+00:00"
},
"modified_dateutc": "2026-02-11T04:45:25.0825201+00:00"
},
"marketing_segment_id": "f906f999-9808-4a5f-8676-7495079c4401",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "813ac2d9-4e5f-4d68-9ab8-1382427dd68e",
"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": "580f996f-0f13-4edc-ba05-009965bda822",
"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": "1763d46d-02b8-4c1e-abaf-e13aaeaea665",
"db_country_code": "sample string 28",
"feelist_id": "4f8ded91-1d52-4275-b1ec-6f06dda457dd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2a0ef8f0-4b00-4e3f-bdc5-e0aabab9cf49",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "51796a33-bd2f-4a52-80ac-23257ec4763f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-11T04:45:25.0825201+00:00",
"db_currency_id": "e54904bb-c0c2-448c-8eb1-39217ee88bbf",
"db_currency_code": "sample string 10"
},
"company_type_id": "3628803f-c5b6-4960-a68b-a56ea894d0a6",
"company_type_name": "sample string 32",
"company_type": {
"id": "4dd82cd9-05be-47ed-8b05-fc17e03e5868",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "804d48e2-ff67-40f8-9750-14422408245c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "291bd88b-cb33-4ff3-a153-6a4cd9da2352",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6698d2af-8b70-4348-8043-e28a083deccd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "27d5b882-ae56-4ba6-b9c5-116562f9fd5d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4eddde32-9745-4673-a728-8759fe236b50",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-11T04:45:25.0825201+00:00"
},
"company_sector_id": "3b52c866-fac4-4c07-9472-21f1cc4327f7",
"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": "a8126e32-02fe-474b-9616-8a61662f83ec",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2b5d9ee7-fae3-41ce-85ac-17b711af4000",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "76c07700-940e-41d0-b992-b1f8918c3ff7",
"account_manager_user_code": "sample string 56",
"company_status_id": "4900ca58-881e-4e49-82eb-03b37d54679c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-11T04:45:25.0825201+00:00",
"id2": 60
},
"db_language_id": "1366d181-038a-4caa-9808-9d02f5cf6be5",
"db_language_code": "sample string 7",
"db_title_id": "287d8021-c252-4939-8672-13d22e47e009",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-11T04:45:25.0825201+00:00",
"create_date": "2026-02-11T04:45:25.0825201+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-02-11T04:45:25.0825201+00:00"
}