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": "eee2f459-a8b2-4594-9575-5822a523bf27",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3280f142-4872-4ad0-8ad7-ecc9143acb1c",
"company_code": "sample string 5",
"company": {
"id": "d0a38233-10bf-4059-8081-8d85558540de",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T03:50:35.362488+00:00",
"sales_territory_id": "b04a5949-0b70-4c29-b9d1-a5065e40875e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5b0e0ceb-7aac-48aa-bd1c-5fb27b44df22",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "463853dc-a5a0-413a-b972-f0b290f551d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e73d2e06-f159-4a20-bfb2-58d4300bf672",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef1707d4-e3b8-412a-b05d-986cad88fcd5",
"db_currency_id": "3891c969-30e3-4eda-9621-14c735bc670a",
"db_language_id": "c08563f1-13d7-4a6c-9b7d-47aee13f14f0",
"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-04-18T03:50:35.362488+00:00"
},
"modified_dateutc": "2026-04-18T03:50:35.362488+00:00"
},
"marketing_segment_id": "1ba1f66c-7c87-472c-98c4-67c27590314c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c29746f5-d81b-4df4-8317-e3bb7759c66a",
"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": "eeb24747-3488-4c48-b542-082309b956d4",
"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": "afee37a2-23db-420d-8c46-8d2864884cfe",
"db_country_code": "sample string 28",
"feelist_id": "b6e51597-0c82-4b81-8348-0e814505dfab",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b10e9a20-d59a-4e3c-acd8-7843d7b5b651",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "412f35fb-ed35-41d3-8f52-4a005beb0e73",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T03:50:35.362488+00:00",
"db_currency_id": "b620af01-d43d-4b13-a375-e2270815dc22",
"db_currency_code": "sample string 10"
},
"company_type_id": "e6f01139-5d8e-4ec9-b2ca-90ec9e6c5f99",
"company_type_name": "sample string 32",
"company_type": {
"id": "c5cc7763-c222-40f1-9db2-2140dc724a74",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d1e7829c-b447-4f57-a8a5-219cd0e7658c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c917cdfa-43d6-4cb0-9fd8-b3e532cb6104",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "184901dc-08f8-4912-bad3-ce51d7a09292",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5bea9ddb-8884-4f9d-a4a5-b21407d62c13",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b3ad9cd9-a6cb-405d-ac7c-0ff040ccd92e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T03:50:35.362488+00:00"
},
"company_sector_id": "bdb6bec3-b266-4515-8890-feb9167afd84",
"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": "d973d9f9-0964-4242-9d9f-eaa55a24186b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e25f0003-3a16-40d4-a7af-7400b25b63c2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4ca5857b-0b90-4640-a3dd-b22854553bf9",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d8cff4c-dceb-453f-b96f-5afa47c46cb5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T03:50:35.362488+00:00",
"id2": 60
},
"db_language_id": "bf2a573a-1544-42ae-a127-ec6d5444f944",
"db_language_code": "sample string 7",
"db_title_id": "f2fb339e-a97a-4e23-9b3a-fa50a6ccccd1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T03:50:35.362488+00:00",
"create_date": "2026-04-18T03:50:35.362488+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-04-18T03:50:35.362488+00:00"
}