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": "ee316d92-b218-4d34-a6e2-71b955f05de5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8e8b7072-58a7-4fde-939b-83cf6ed47417",
"company_code": "sample string 5",
"company": {
"id": "2b41915a-f198-406a-a248-eb979f27a7e3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-06T11:04:49.1955326+00:00",
"sales_territory_id": "1195e258-2d9b-41d7-a3b0-ee3dba85235a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4bc0c947-ad70-4b94-bd33-11d0a5a8f459",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eca1678f-1eab-4300-9044-bc8f0677cb8f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "122fcd63-e23b-4a38-b75d-33d92a27c600",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e8efc8b-88bf-4a46-a5d2-244bff3b1f39",
"db_currency_id": "221dd065-4389-4e93-a5a0-4ded8ac3c0b9",
"db_language_id": "598fc0b6-aa32-402b-a6c7-addd99b24f46",
"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-12-06T11:04:49.1955326+00:00"
},
"modified_dateutc": "2025-12-06T11:04:49.1955326+00:00"
},
"marketing_segment_id": "cb96d2bc-30b6-42d9-b923-d0760f24d359",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "83002e11-7ed2-42f1-95ee-df81ccdba649",
"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": "7956a6ab-991c-4632-a057-f7472b4895e4",
"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": "73c69503-aefa-4541-97ed-176668e006bb",
"db_country_code": "sample string 28",
"feelist_id": "bb62f641-e6ee-4b88-bc73-a663ac5743eb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f3745dc-883a-4b2a-88bd-1af4e5bfcc64",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bb5b669f-26ec-44c5-8304-ba4885e43c1d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-06T11:04:49.1955326+00:00",
"db_currency_id": "18940fdb-f395-4c10-b7a4-2163bbb7613c",
"db_currency_code": "sample string 10"
},
"company_type_id": "1778345e-1070-4ffa-91bd-5982b15d9caf",
"company_type_name": "sample string 32",
"company_type": {
"id": "ef28876b-3708-44d3-9f94-b35547e2d6ea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7daca115-510c-42da-b4fc-26a5427403fc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c2c366e-ee91-416b-8685-9cd620d5a942",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "94c5e84f-cff6-41a1-8c0f-c3edddc16985",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7e122fc6-0338-455c-87fe-a99341175c35",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dbbf8af9-bbc8-4e69-8fcb-ab0fa1a6ca01",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-06T11:04:49.2111604+00:00"
},
"company_sector_id": "ae13ec41-436a-4197-8693-acdba9f3b6b7",
"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": "08bc6f68-720f-46b4-9a60-06c473f060d7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7b0df074-cfbe-49e2-b5f7-f29324d40d4b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f4c7848a-89ff-448a-8e84-85f281fd7e8f",
"account_manager_user_code": "sample string 56",
"company_status_id": "654bc970-ea74-4a84-b28c-50599e01f84d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-06T11:04:49.2111604+00:00",
"id2": 60
},
"db_language_id": "dc2e2331-1f6e-4a06-bdfb-eba2b4e3624c",
"db_language_code": "sample string 7",
"db_title_id": "25cd6fce-0bf5-431e-9b93-a5150b1c84a2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-06T11:04:49.2111604+00:00",
"create_date": "2025-12-06T11:04:49.2111604+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-12-06T11:04:49.2111604+00:00"
}