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": "5c0a098b-c0f2-4f83-8b06-8c96cc5cf97c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d3192b10-0e87-4faf-90d2-063737ebd975",
"company_code": "sample string 5",
"company": {
"id": "64e7b58d-3f75-46d8-b4b4-35ba63966a6e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-20T12:54:19.7056682+00:00",
"sales_territory_id": "73d4ae92-3f5b-4c98-93f1-a4e77c8abc6d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd1127c8-7a8c-42c3-925a-9b149048b54e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "deb545c6-8ac7-4a9c-bbca-eed5695f9c44",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20b8199c-ad9d-4bee-bb4e-246d7c4fec8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34da5557-36d8-4265-9aae-178ab43115f3",
"db_currency_id": "cac5705d-79bb-4aa6-968d-8f5dc49100ea",
"db_language_id": "d578e839-0b25-4120-ba44-d6e06480cd89",
"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-20T12:54:19.7056682+00:00"
},
"modified_dateutc": "2026-08-20T12:54:19.7056682+00:00"
},
"marketing_segment_id": "7205611c-0784-4ff4-806e-62fad21ac761",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d67aa5d2-3aef-48ed-939d-84519d19ae6f",
"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": "2816c44d-e349-4ce7-bff6-95831e55001d",
"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": "cb24701b-7b33-4cc4-8fb7-bb9944daab54",
"db_country_code": "sample string 28",
"feelist_id": "c4137d1e-298c-4467-8ee4-e334f9f70341",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "383f4162-a110-4d32-9b11-eaee6cbba577",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f98d721d-55e1-4e97-a910-4f2d468811a3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-20T12:54:19.7056682+00:00",
"db_currency_id": "6099afa8-a23e-49a3-a99e-716a5b6ee788",
"db_currency_code": "sample string 10"
},
"company_type_id": "e4d00676-35ee-4297-9a8e-11a75f196034",
"company_type_name": "sample string 32",
"company_type": {
"id": "d67ba9ec-094c-4b2e-9d55-35b0fd178418",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e8a97d5-d7e0-4a35-ae2a-3917327314ce",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6d8d7e38-c4e8-47ae-979b-773711d320d1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4ad7843f-12f6-4687-824c-d636a1b70149",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2633cf4d-7d76-41aa-a2cb-8ea0c962bb16",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bbd957fd-5f2a-44f9-822d-cfcdbab1e356",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-20T12:54:19.7056682+00:00"
},
"company_sector_id": "92b231bd-4e9f-429d-892e-e7142a7ae9eb",
"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": "350fe0bd-26a6-4549-b97f-2cf5801498e6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8efd62c8-d615-40fc-87e3-5c0d9a1684db",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d1a5f74c-a27d-4e68-9b79-dc75831154cd",
"account_manager_user_code": "sample string 56",
"company_status_id": "ae217692-d128-438a-97ff-d75b32fa25ab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-20T12:54:19.7056682+00:00",
"id2": 60
},
"db_language_id": "5bfb6edb-eb52-4c37-868a-3c0f8fc6be92",
"db_language_code": "sample string 7",
"db_title_id": "a39cf382-9b93-42ff-9d83-d50d59ad9bb4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-20T12:54:19.7056682+00:00",
"create_date": "2026-08-20T12:54:19.7056682+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-20T12:54:19.7056682+00:00"
}