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": "cd825386-92ac-49b2-8460-19172f6d29c9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b10f8ab7-a303-40d0-8fcb-c3ee9562a3f6",
"company_code": "sample string 5",
"company": {
"id": "e12c040a-3be6-4bae-9656-1dffca9aba4e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-30T17:28:18.8823648+00:00",
"sales_territory_id": "7e26489b-bd16-439c-8663-6b2bf34ea5c8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "181bb2aa-a38c-41a7-b2b3-e6dc5142ec55",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bd6dc8ea-a959-44de-85df-a5aa96ef1493",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "58fbab28-80fc-48f5-b558-6fd0c39a5c84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2bb1f335-8125-4b0d-b23a-640bf18efe59",
"db_currency_id": "313b8eea-22c2-45c0-9e8e-7bbfcf3ca8e9",
"db_language_id": "bf029653-8162-4b05-96bd-4e8e11cddefe",
"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-05-30T17:28:18.8823648+00:00"
},
"modified_dateutc": "2026-05-30T17:28:18.8823648+00:00"
},
"marketing_segment_id": "65e73acb-1ada-4db7-b718-b4aab77f828a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1b5afdaa-4d71-4f82-9141-a51ef43baf3e",
"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": "f94c6bfc-477e-425b-a076-6ae073a76656",
"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": "38b77ddc-e0a6-4b95-aaf7-dd872283524b",
"db_country_code": "sample string 28",
"feelist_id": "39da5473-bae3-4a24-861f-39360ef26062",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5d69a1a0-8191-427b-b379-11ede6eeded9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7a70b63c-e67d-4b16-8d64-5413fc16e3c2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-30T17:28:18.8823648+00:00",
"db_currency_id": "e854b41c-d70a-47bd-9898-17a9c8409a88",
"db_currency_code": "sample string 10"
},
"company_type_id": "3aba4261-b363-4cd9-b629-cb1f666dad26",
"company_type_name": "sample string 32",
"company_type": {
"id": "51493e2b-80c4-47a6-a626-f10c7b559978",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c018ab63-5e1a-481d-936f-babf59dd2309",
"sales_organization_code": "sample string 5"
},
"db_language_id": "91c8d495-20f0-427b-844a-044c904ef567",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2f3badc1-bbc4-422e-a817-9d1c272ebe8b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a0cce17e-e500-4f04-92ac-8d9b022789b3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "015ef930-3ce6-4957-a245-338a0b4882e9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-30T17:28:18.8823648+00:00"
},
"company_sector_id": "bfb0c0ba-7085-43dc-8978-334c3d6aeb2d",
"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": "e632d62b-25d1-4e90-9bea-8ba2069b6fb9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b49129de-0e63-48fe-8f70-5d705578aa4b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce6802ef-d4fb-4eee-92c4-19854e4f0e1f",
"account_manager_user_code": "sample string 56",
"company_status_id": "b56e50ef-2853-41c5-b859-1448f4bbb332",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-30T17:28:18.8823648+00:00",
"id2": 60
},
"db_language_id": "3d6c52c5-8016-4a67-9995-dff2f9771069",
"db_language_code": "sample string 7",
"db_title_id": "5b3a08c0-d367-4143-87b3-2283d9799d73",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-30T17:28:18.8823648+00:00",
"create_date": "2026-05-30T17:28:18.8823648+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-05-30T17:28:18.8823648+00:00"
}