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": "481ee7af-d745-4fb3-bdd1-b4e5eb55e2de",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dd174fd7-2790-400a-9df3-d7ccb4e51bcc",
"company_code": "sample string 5",
"company": {
"id": "8dc03f4e-37bd-4742-8297-7c3e8f53db7a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-01T09:31:46.5671678+00:00",
"sales_territory_id": "b9715150-a390-40ee-bce0-c9af0ada0233",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "60301db7-6f83-4fa6-9450-ec4dbc20b083",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f57d1c87-da19-4ed0-8917-f1933e9f47d3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "04bc1fb8-352c-4a43-aaab-d68e852eb84a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cae250ae-eb0b-4fb2-b764-776c600e491c",
"db_currency_id": "97207564-a2da-4a2f-adb4-64e2e3951db1",
"db_language_id": "af50910c-f68a-4533-9ac1-151004fa8de4",
"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-11-01T09:31:46.5671678+00:00"
},
"modified_dateutc": "2026-11-01T09:31:46.5671678+00:00"
},
"marketing_segment_id": "8a6239eb-f9d2-4eaf-a984-d1488cefdef1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5eb9e907-821e-49c0-a3d1-cf1336623a47",
"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": "d4109ef4-42ca-46ab-ba2b-16e09ddf734e",
"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": "075fe182-6cc9-4b28-89d5-d26cfba87b93",
"db_country_code": "sample string 28",
"feelist_id": "7c5fc952-b0de-42a1-9a66-149620cc683c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "928cd0e4-abb3-49bc-bebf-1850c9f7e67f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "33774cb2-b173-4fd3-b7c4-82a82c3d831a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-01T09:31:46.5671678+00:00",
"db_currency_id": "f5fa3cbc-a7b6-4018-b4e8-bad6eea7d670",
"db_currency_code": "sample string 10"
},
"company_type_id": "76ff0233-451a-4895-bad0-45dda2b65108",
"company_type_name": "sample string 32",
"company_type": {
"id": "2d9aad23-4f32-4614-bb74-a2d1e89b32b2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "657ffafc-0431-4717-a2c0-ba1a7a6a6351",
"sales_organization_code": "sample string 5"
},
"db_language_id": "45917430-88cc-4abb-82c1-4f051f001a8a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "07d3fc59-a68a-4c9c-a3aa-c627ba4c1b56",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00a31722-ef96-4a2b-a615-1e07c7a5cc91",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eb590640-ac0f-4e79-b428-be3592f2afc9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-01T09:31:46.5671678+00:00"
},
"company_sector_id": "145346ef-ccea-4d1b-83f9-a8170b33ddda",
"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": "81f93d15-d7c9-474d-89e3-8fb5e147256e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "24a4fc27-30f3-4a01-b1f5-3bc3cd8718d6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7e5176a9-2776-45af-a89a-4747f6481e8d",
"account_manager_user_code": "sample string 56",
"company_status_id": "cd6911d1-5c6a-4a07-a3d3-1df6e03c91eb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-01T09:31:46.5671678+00:00",
"id2": 60
},
"db_language_id": "059949c2-e029-4861-868e-f64fda186f23",
"db_language_code": "sample string 7",
"db_title_id": "10c83b9d-e789-4b79-8a1a-d61eecfa43e8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-01T09:31:46.5671678+00:00",
"create_date": "2026-11-01T09:31:46.5671678+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-11-01T09:31:46.5671678+00:00"
}