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": "d75feb7c-fcfc-4129-a7b8-a1498075ed68",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "11e536c2-0310-4f9c-ae55-3df2eb07cbec",
"company_code": "sample string 5",
"company": {
"id": "62a14f33-bf66-4c69-8d42-ae45328066aa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-30T05:08:16.2819376+00:00",
"sales_territory_id": "271a6391-20ba-4c97-90ef-5108ff2928af",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "93023ee1-18df-4dda-a944-dbd6ca648c4a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8a611b0c-cd90-4b53-8157-a13cf885ccc1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2bbcda44-32e7-452b-a703-f8424839a119",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c76841d1-17b8-4ba7-b620-5a54734d9d0b",
"db_currency_id": "f29bd1ff-0b9b-417b-8221-541f74cc722a",
"db_language_id": "94e58313-52cb-4318-b824-2fd6e482c4b3",
"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-09-30T05:08:16.2819376+00:00"
},
"modified_dateutc": "2026-09-30T05:08:16.2819376+00:00"
},
"marketing_segment_id": "c490ef04-77fa-48f5-90a2-fd56617d9cbf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "411b1816-446e-49de-8bd8-061747cada43",
"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": "0d004372-5dfd-428d-ae7a-dee8bffc9fc7",
"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": "21cbcdcf-1a2a-4c04-a56b-4df2f7a0411c",
"db_country_code": "sample string 28",
"feelist_id": "581ac197-7a14-4f8f-9e3b-703d92a8d6fb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f93f9a3c-4879-4b7a-a6f6-93952bd36305",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0cd711dc-d2fc-4ec0-bd7c-6c0af2a8c32d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-30T05:08:16.2819376+00:00",
"db_currency_id": "931022b7-0b61-44c3-a1d4-414f807998b2",
"db_currency_code": "sample string 10"
},
"company_type_id": "9bbdb52d-e4d2-4837-8042-34492453d727",
"company_type_name": "sample string 32",
"company_type": {
"id": "616d0253-c464-41de-bb58-a0043c47f389",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27c4a176-7816-4849-837d-f0bf4b12e07d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0383b595-66ea-4b7c-9c02-fd8943a66c62",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "83eb35f8-9551-4f1d-9342-0e24e365550d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7574f632-b164-4eed-9858-09f380c9bfb9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2936afb5-a613-49c5-a0f1-5ab11e0fbfd4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-30T05:08:16.300311+00:00"
},
"company_sector_id": "415ecc8f-7a32-432b-b66b-682511368481",
"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": "69cf5488-2ec2-413c-9f14-92d02cb6e525",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cba9c8a2-97ca-4243-926b-4daa627d3e86",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "76b93594-1ad6-4078-a258-c0a82dbcf85b",
"account_manager_user_code": "sample string 56",
"company_status_id": "260867b7-e774-46be-b362-88bd2069f511",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-30T05:08:16.300311+00:00",
"id2": 60
},
"db_language_id": "9116efb0-02be-4bcf-97d6-fc049f62f858",
"db_language_code": "sample string 7",
"db_title_id": "024e7fc6-d5e3-4d61-906d-78db51ba27e7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-30T05:08:16.300311+00:00",
"create_date": "2026-09-30T05:08:16.300311+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-09-30T05:08:16.300311+00:00"
}