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": "f643281c-bd1b-4a30-922e-c9a287f6c358",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1c53060b-0eba-498d-9941-afa7d8b2385e",
"company_code": "sample string 5",
"company": {
"id": "90f3515d-8d4d-4ef2-87af-384fd7d47d0e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-02T06:20:57.7401368+00:00",
"sales_territory_id": "93244359-5b8f-4415-bf6e-2b1b1c44ec08",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e1ae0fa2-c384-4a0c-909f-a5a8b07fcdd2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a57563bb-efb7-477f-9c5b-dca5f2b04623",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "346895c6-9849-4673-84c6-a227cc6a52a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9663fc29-bb82-43c9-ad44-7ed802fb1fb8",
"db_currency_id": "150aa556-4ff9-4ddf-ba35-b63b8010c45b",
"db_language_id": "4749c71b-6cd8-4efb-ad93-012a68d03bc6",
"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-02T06:20:57.7401368+00:00"
},
"modified_dateutc": "2026-05-02T06:20:57.7401368+00:00"
},
"marketing_segment_id": "8747ce2a-1c98-4e43-b1db-6c0aa3b7ad38",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dc2baab2-b296-4e09-93c1-56d071a6495d",
"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": "e11de178-70fe-42a9-ab9e-6c5dd32d36ee",
"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": "6784a797-6629-4239-ae91-92ccf542830c",
"db_country_code": "sample string 28",
"feelist_id": "8dd8b7fa-af9c-4457-abe9-5a09599dd339",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "66ac44ea-2ada-4517-8a70-ccc1bc171389",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fcc13a43-bef7-4b75-86a3-0a83c1c9fdcb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-02T06:20:57.7401368+00:00",
"db_currency_id": "477da88f-1a2b-4771-8573-666233e6aa8a",
"db_currency_code": "sample string 10"
},
"company_type_id": "7156ad06-7574-4f62-9d3d-861cb7de6a42",
"company_type_name": "sample string 32",
"company_type": {
"id": "0d0aae53-ec2c-4907-bee5-c45545abf505",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "721c797c-b6c4-4a69-8aa5-1751c7de9d35",
"sales_organization_code": "sample string 5"
},
"db_language_id": "85b39dfd-fd1a-4a28-b89d-e1d7bd32d81f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ad20cc97-f434-48f4-9e0c-c95d5e50dcbb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56a1727e-481b-4859-b786-a72557a2ffdb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4ef298b6-1f03-411a-9012-fde6b54f751a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-02T06:20:57.7401368+00:00"
},
"company_sector_id": "1ba829c4-0862-4471-bc6b-1b9fb876e3cc",
"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": "37e9a47d-b3ad-488f-a24d-40ac1f13a922",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "db9350e5-5dc9-4bc3-9614-64093f7288dd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "78a92608-5156-4aa0-af06-3da1cf77ffd5",
"account_manager_user_code": "sample string 56",
"company_status_id": "acf9da00-2240-46c6-8972-95e89338329e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-02T06:20:57.7401368+00:00",
"id2": 60
},
"db_language_id": "9d055d4b-7789-4cec-91b2-162018bfb448",
"db_language_code": "sample string 7",
"db_title_id": "f3c61122-82c7-4c6f-80e2-929e25d48f0f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-02T06:20:57.7401368+00:00",
"create_date": "2026-05-02T06:20:57.7401368+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-02T06:20:57.7401368+00:00"
}