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": "a59bfdf4-a300-4ee5-a08e-8d4d49ab0f3b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a48606a-5521-4ebb-8567-240639416396",
"company_code": "sample string 5",
"company": {
"id": "a0238d64-4bcb-417e-b9c5-075e32d8b1d9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-21T21:44:47.3991347+00:00",
"sales_territory_id": "91839990-e55d-404b-a9fa-d4f2531119bc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "20d5c904-99e1-4614-9c6d-1213554e7008",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81fd625e-4bf3-4a62-976c-4f765d79419b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aecb7691-efaf-4e59-b530-0a8dcf3f4467",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "acdbd41a-4e79-4187-9ebe-35f307b499b7",
"db_currency_id": "672bc574-98dd-4a65-940d-fa6ccfbfb117",
"db_language_id": "8058cea1-d2f0-4799-8863-64d4b3ebcb4e",
"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-21T21:44:47.3991347+00:00"
},
"modified_dateutc": "2026-08-21T21:44:47.3991347+00:00"
},
"marketing_segment_id": "7715556c-a149-47e1-8154-3f3096ea8113",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0618a54c-3ec1-4116-bb8c-881a02aef359",
"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": "dcddc035-7fa1-4c01-891c-24675738b1f7",
"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": "ff5a141e-98cc-45b4-8a74-d2df3ab59d48",
"db_country_code": "sample string 28",
"feelist_id": "f3f95a35-78c4-4d88-baf7-ab192fecba35",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fccd4f00-4cb5-4e74-a926-5e2e95ca5346",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "83fc4a61-7571-46df-a46d-b893bea6c6f8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-21T21:44:47.3991347+00:00",
"db_currency_id": "958b4849-ab63-408d-913b-b08a673bd905",
"db_currency_code": "sample string 10"
},
"company_type_id": "9f1b3ced-ab08-42cc-92e6-6bdbf508a0ae",
"company_type_name": "sample string 32",
"company_type": {
"id": "9c63cd3c-ad5a-427f-a242-2d61168a676e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b3ad0932-2be7-4184-b420-cb49461a2065",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eaff8b68-8310-4310-8e94-3f456525aafa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fd24bf21-3244-4d33-8728-e07c048cbfdb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1069b966-96b8-44dd-949a-2b75fc5d825d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d0363aed-cd99-4048-b5ab-123db7e3839a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-21T21:44:47.3991347+00:00"
},
"company_sector_id": "6d74497e-23ec-4431-9861-23eb853951da",
"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": "4a34e678-ac70-4062-bd8a-289dc0c56921",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "02a18a12-e8cc-4e6f-9d08-5ed45c266f06",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cdf2b351-a461-4426-808e-bfc6a55d01b7",
"account_manager_user_code": "sample string 56",
"company_status_id": "cfbb7d39-e461-4186-a26b-0f7327988ef1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-21T21:44:47.3991347+00:00",
"id2": 60
},
"db_language_id": "4e2e00c0-6478-4d18-9fb3-1df893a1013f",
"db_language_code": "sample string 7",
"db_title_id": "acaaebf4-07fd-4e59-a031-1559e3500c8c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-21T21:44:47.3991347+00:00",
"create_date": "2026-08-21T21:44:47.3991347+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-21T21:44:47.3991347+00:00"
}