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": "2606b937-397b-46ba-a71b-a8766c1ed073",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "093b2f1a-da79-44e7-a4b6-11f6c21bb653",
"company_code": "sample string 5",
"company": {
"id": "8bf6a791-018d-4fee-acf7-4709107a8f26",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-07T18:11:42.2500326+00:00",
"sales_territory_id": "f1532e88-6f1d-4362-bc8f-0fb01165cae9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4a2b904d-40c0-4eb6-9d8b-1e52b7d0fc78",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e7223a4e-91ca-4f09-8374-a78435a28e9f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "acd73b38-bba9-4cbc-805f-cd6786eba73d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40150947-8dc4-49e8-8725-06c31f918e49",
"db_currency_id": "deeafe67-803d-4542-81ba-eefa18036744",
"db_language_id": "877026c5-3743-4953-abfe-9eed095b1c0c",
"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-09-07T18:11:42.2500326+00:00"
},
"modified_dateutc": "2026-09-07T18:11:42.2500326+00:00"
},
"marketing_segment_id": "72ec6cd3-492e-4802-8a87-f051ea80abb9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "992899b1-c1f3-4715-8125-7202e3e618e6",
"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": "75af2b1c-9a60-4ddf-9319-84a7de954077",
"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": "0556d4ce-13d5-4c71-b302-f4aa0b206181",
"db_country_code": "sample string 28",
"feelist_id": "4bb81f0f-a7ce-4495-88be-49713b206354",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "faca5f9e-0e98-435d-a8b0-04a24e34feab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f08595f2-ee2d-44c8-a2a2-6b3d34d51071",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-07T18:11:42.2500326+00:00",
"db_currency_id": "e945c91b-0e2c-4ef4-b44b-8080a8ff5c4d",
"db_currency_code": "sample string 10"
},
"company_type_id": "ea752841-aaac-4452-8b98-38de261d49f8",
"company_type_name": "sample string 32",
"company_type": {
"id": "9970b646-6dc0-40f7-87fa-7a4bf96173a1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f6d87ed-4452-4a05-ba2d-4bfd7c5ab274",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c30bc57a-bca4-4212-bb27-e8e289289b2a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6a752a16-04d0-463a-91fc-c8376723a5f1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6d15db4a-c356-4be2-afca-ec4e7fcced61",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9d981408-c2ca-477e-832d-ac712a59f805",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-07T18:11:42.2500326+00:00"
},
"company_sector_id": "f0dc61a1-b1b4-40e2-8f72-a14b485722c0",
"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": "ebadbbc4-2dd4-4147-a499-dc161e28ff7a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "00c16cc2-fa08-4cc9-9115-38a9249317d8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4414b3f3-c442-4514-8f22-bb1ebacce40f",
"account_manager_user_code": "sample string 56",
"company_status_id": "49168ce2-30d7-4d7f-826c-4353f89d7842",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-07T18:11:42.2500326+00:00",
"id2": 60
},
"db_language_id": "3ca4cd45-2f5f-46c2-a42d-954ac2679b76",
"db_language_code": "sample string 7",
"db_title_id": "2602ef25-f847-4a91-a2df-7a72f49e2bb1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-07T18:11:42.2500326+00:00",
"create_date": "2026-09-07T18:11:42.2500326+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-09-07T18:11:42.2500326+00:00"
}