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": "85f166b5-2b12-4b57-ac1d-201247981076",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7fc89602-8ae7-448a-955f-c95fa640e645",
"company_code": "sample string 5",
"company": {
"id": "1f6390f5-49f4-47ec-919f-265754c42744",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-02T02:46:52.9957215+00:00",
"sales_territory_id": "338fbfe1-2dbc-4531-9a4d-28868f074c1f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e4c7727c-a2d5-4301-b742-9ac77d9a3d83",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bb8fc041-6ad9-40b8-8dd2-8fc61f6c4b94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2f06fad3-2490-496b-a450-1bb745d6fb86",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c046547-17fd-440f-bf49-54d08e546f56",
"db_currency_id": "445b8fbc-526d-47de-9528-da841e6eab71",
"db_language_id": "711f6dc9-6875-4098-ac42-2968c8fbd1a8",
"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-08-02T02:46:52.9957215+00:00"
},
"modified_dateutc": "2026-08-02T02:46:52.9957215+00:00"
},
"marketing_segment_id": "bb180656-03ca-4b4b-adab-d8f2e49275e9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "280f372d-c6ac-45c3-ad85-742f67791e96",
"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": "45c0936a-93d2-45e3-98df-f43ce6ff19da",
"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": "4798ae8a-bd33-4f29-9fe7-8bffe66b5ea3",
"db_country_code": "sample string 28",
"feelist_id": "2b003a3d-905e-4af3-b9f4-4991244ca29b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7a818446-f86d-4217-9e16-3ad0598a9909",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "52ff642f-860b-49f0-87ea-f88eb4fa754a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-02T02:46:52.9957215+00:00",
"db_currency_id": "bdef8ec7-2756-41ee-9d13-bc559c0dddbf",
"db_currency_code": "sample string 10"
},
"company_type_id": "277c40a5-dad8-49f4-a164-3522deb1d35c",
"company_type_name": "sample string 32",
"company_type": {
"id": "fa35b139-b660-4962-8db6-b4fb56038f42",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a137b0a0-8ef6-4bd4-82c6-0d0e93dce685",
"sales_organization_code": "sample string 5"
},
"db_language_id": "81918686-21e9-4542-a560-b68ae55c5ee6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "737c8603-7aed-464d-a871-da7ce46cf03c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "667f6dec-10cf-4f9d-82be-28674fef8e56",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cbb95f00-a61e-40be-a73e-81fc80afab59",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-02T02:46:52.9957215+00:00"
},
"company_sector_id": "327f06d8-19c2-4930-878f-f4e13da34bcb",
"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": "e95a8605-2a97-4075-aa9c-ec86dbc7940f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6d04ed33-1000-4963-9384-543a5f0946d9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "212411c1-fd3c-4c21-a426-73ba85e4a6df",
"account_manager_user_code": "sample string 56",
"company_status_id": "64252d5b-b138-465e-910e-d3e0447e5f66",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-02T02:46:52.9957215+00:00",
"id2": 60
},
"db_language_id": "91e9621a-12bc-42a2-8fe6-ef0108d4b420",
"db_language_code": "sample string 7",
"db_title_id": "53b5c6e1-e008-4a4b-912d-8192ed57fdd3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-02T02:46:52.9957215+00:00",
"create_date": "2026-08-02T02:46:52.9957215+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-08-02T02:46:52.9957215+00:00"
}