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": "79487352-91bd-45a9-8e47-59d13839f38c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6493b026-39f3-46c6-af1d-723a8f89529e",
"company_code": "sample string 5",
"company": {
"id": "33765812-1657-42c2-ae89-720478b5f888",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T04:48:50.492205+00:00",
"sales_territory_id": "ca2e327a-0816-42fe-aa8f-6e44f2914468",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "62d09ca9-816e-4a47-945f-b0b984dfb449",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5c1999c-f093-4c1a-b968-2c569e45c045",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4bffbd0-d410-4220-b7e4-0a040bad0a89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a4af11d-49dc-413c-bbc4-9d7c47872257",
"db_currency_id": "0303ba70-e438-4f3f-a70b-f72439731f71",
"db_language_id": "bfa734f6-a2b4-4495-b7e0-301c31123057",
"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-10T04:48:50.492205+00:00"
},
"modified_dateutc": "2026-08-10T04:48:50.492205+00:00"
},
"marketing_segment_id": "aabc05b0-a196-4196-a0a8-6110710bad23",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1d16afc3-47ff-4029-a37b-f60c09dc5d23",
"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": "5bf57cc6-d769-48e9-859e-ed8121f62524",
"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": "7f62a5f0-9bd5-4338-a67c-4cfe80086139",
"db_country_code": "sample string 28",
"feelist_id": "5e7a7fd7-776a-4e8e-99a7-e8345144d2d6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "eabe4dea-2f7b-4339-9e6a-94ef17aa5172",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6f2ddc41-8202-4bd1-91b0-0396c60d3540",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T04:48:50.492205+00:00",
"db_currency_id": "c4ed7c9c-3518-4953-a504-90201480de09",
"db_currency_code": "sample string 10"
},
"company_type_id": "a1686895-34b2-4042-a0ac-2488c1319e2f",
"company_type_name": "sample string 32",
"company_type": {
"id": "3aa700ef-56ac-4339-9b9d-ae3b1414b149",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "32182953-550c-4ab9-83f8-c41255e070b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2d3d22d5-0327-48bb-8fde-112f2f3f6428",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ba7c8ce6-716d-4ace-8fea-3eab24232b38",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9ca8920a-50e6-46f7-b8e5-bc71ee05738c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0aea787c-aff5-432b-9388-5fc929a17e85",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T04:48:50.492205+00:00"
},
"company_sector_id": "73fcd093-132c-4433-b37d-289f5cfd7430",
"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": "2e5d7698-ad09-429f-99b7-ec581bc81fcb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f2509cf9-d84e-4981-8dba-402e1290b147",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ca81ad82-9421-48ce-ad82-493f1b43fd0c",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ca3e5e9-22e3-4466-8faa-9ee7f4d7cf8b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T04:48:50.492205+00:00",
"id2": 60
},
"db_language_id": "00613401-eb76-4107-9bfe-41373d25a980",
"db_language_code": "sample string 7",
"db_title_id": "13842880-0e32-4bb1-8c22-785acf5a963b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T04:48:50.492205+00:00",
"create_date": "2026-08-10T04:48:50.492205+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-10T04:48:50.492205+00:00"
}