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": "aa43e53c-81ea-40b6-b3a3-c07647e56d27",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e3aef878-adf7-4eb1-9db7-8f2ea570107c",
"company_code": "sample string 5",
"company": {
"id": "36165a43-fb0f-457a-bc4a-06e125451408",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-21T05:39:32.5879065+00:00",
"sales_territory_id": "c5d7adb4-753f-4017-97a4-792a77200baf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "89077bf7-fa74-4e60-afff-71dfb575a3f2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f656e499-baf3-4473-a847-9a9ec26e1b5b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70ef3861-a12e-4c5b-a80d-3e35e468111a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e865e7d8-109b-49f9-8b9d-0ffee0b713a5",
"db_currency_id": "640c3cec-7bc6-41ae-801e-a30ef2110f12",
"db_language_id": "f365c2a7-b9c9-4def-8a16-fad4af49ca62",
"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-07-21T05:39:32.6035307+00:00"
},
"modified_dateutc": "2026-07-21T05:39:32.6035307+00:00"
},
"marketing_segment_id": "9c174e88-55b1-47cf-96a5-01b523ae4ce9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff612136-fe30-4811-bc3b-336186ebded4",
"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": "937add71-7f3e-4f71-ab09-7bdfd92e010d",
"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": "d743cd17-d22f-4341-932e-7ef4fee68cd5",
"db_country_code": "sample string 28",
"feelist_id": "3e1e81e8-7ef3-4e87-a578-01c350805226",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e6f388fb-d675-4256-a1c8-64d2b7a2886e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c59d3b85-e959-43c1-baa7-ff771ca5c1a4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-21T05:39:32.6035307+00:00",
"db_currency_id": "b38b9faa-52b4-461a-b32e-fef9cdb8177d",
"db_currency_code": "sample string 10"
},
"company_type_id": "4326ea18-2154-4e5f-8a63-3c987588156b",
"company_type_name": "sample string 32",
"company_type": {
"id": "7b52ba51-ad3c-4334-8c5d-cc85e355598f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b8168779-461f-4e82-ad11-c60066251004",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a2639db5-4a19-439a-ae94-63c91b2edcab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "add1b7a9-adbe-4488-baa7-c7786ee54c02",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4289e294-7465-46d9-9427-40dd65889d4d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d946a5d3-97cc-43e1-929f-05d9d33ead24",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-21T05:39:32.6035307+00:00"
},
"company_sector_id": "99da56dd-b8bb-4487-8398-5e73cd647b48",
"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": "7602c554-30bd-4ce4-bd81-acbd79a6fb6d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "23ce92d1-80ab-4283-ad51-efc6e0db040d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a26cda60-d54f-476d-a162-b9cf8216db46",
"account_manager_user_code": "sample string 56",
"company_status_id": "7142b7d5-5818-4b27-a431-45359536a4e8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-21T05:39:32.6035307+00:00",
"id2": 60
},
"db_language_id": "7035a5b7-f8e2-4798-9ec7-cc8e85e293c0",
"db_language_code": "sample string 7",
"db_title_id": "9a83ca65-ab75-4b9d-94b6-38e8f2d15cc6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-21T05:39:32.6035307+00:00",
"create_date": "2026-07-21T05:39:32.6035307+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-07-21T05:39:32.6035307+00:00"
}