Retrieves the company 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": "cc86a8e7-92f7-46f6-8ba3-ef19dfbb7bc1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "df47c30f-4792-49ff-99c0-61155a23d574",
"company_code": "sample string 5",
"company": {
"id": "3066ea25-ad44-4519-9334-32ec819cbab8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-08T18:26:50.2674017+00:00",
"sales_territory_id": "491d3508-1c8c-4a52-9914-463f72f7d855",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7cf925d9-506b-4d78-ab51-3181b19cf639",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c7d907a-0f31-44c3-8425-b1f05112305a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6b0805df-f922-45b5-bb74-1f1b0c5f4561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bd31028e-6d6f-470b-8b81-77d0c4092e48",
"db_currency_id": "76250981-7de9-4b62-b35e-76ad05c02a74",
"db_language_id": "5cf43cd4-288e-4017-8aa8-28e97a619267",
"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": "2025-10-08T18:26:50.2674017+00:00"
},
"modified_dateutc": "2025-10-08T18:26:50.2674017+00:00"
},
"marketing_segment_id": "dd3b6c98-bfb9-42cd-aa76-a3bd457364b1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5b7c53cc-9d5a-4c84-a11a-da44b9971f20",
"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": "9128d17e-5f02-4974-880a-94acf6b03493",
"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": "71d43bbf-5917-42e0-a92b-653770a9f15a",
"db_country_code": "sample string 28",
"feelist_id": "99e5057f-e2d5-4921-b627-98e97627f9af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "52220c82-bc6c-4374-9ec9-eaacf0f3b53a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "51a0ba0f-08b8-4728-9f12-a00e8aa32b74",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-08T18:26:50.2674017+00:00",
"db_currency_id": "e51ba0b8-1dc4-4ed3-bb35-cd9f8a90d965",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ca6de2c-e2ed-4fa8-b7eb-529ad308f6a9",
"company_type_name": "sample string 32",
"company_type": {
"id": "0dcf6229-c9d8-41b2-aa9c-207fb955221a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "03c14f78-8bf5-4c1c-8d65-059de118002b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "11283d0d-3aa3-4c4d-aed9-ab73d1be52b4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "afdce70e-fa30-415c-8f1b-750d3048c24d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1b42f744-ccd1-46bc-a8e6-0bcfd5d7cf86",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "220f89a1-0afd-48f6-84fa-189e539e4694",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-08T18:26:50.2674017+00:00"
},
"company_sector_id": "16ee270a-ba99-4f89-8bf2-f0d61bc73820",
"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": "5841023b-b648-45d8-9130-9314f8558492",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bf6791a6-2c5d-479b-9611-29d63e8ef905",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cf6b4ad0-eb49-4dd6-a0f7-e8877311ac63",
"account_manager_user_code": "sample string 56",
"company_status_id": "5431b39d-a526-43b5-9a3b-44e92d53d8e3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-08T18:26:50.2674017+00:00",
"id2": 60
},
"db_language_id": "61bae943-d0db-4f40-b38f-cf9415d43384",
"db_language_code": "sample string 7",
"db_title_id": "3a58f662-f860-4821-81ed-ef5cf40cc422",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-08T18:26:50.2674017+00:00",
"create_date": "2025-10-08T18:26:50.2674017+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": "2025-10-08T18:26:50.2674017+00:00"
}