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": "a20cd713-5100-45c3-9c93-89f73df619e3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3778e57e-f9e9-4058-997e-3e0f4ca1dd48",
"company_code": "sample string 5",
"company": {
"id": "3ec82fc1-9311-400a-9ee8-b91dde95b9d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T22:52:05.1732212+00:00",
"sales_territory_id": "0477615f-abe5-40b5-8f89-9ae1b259212b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5b1fa23f-7b39-4168-926e-a5e8034dd3f7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ade23b3f-d1b8-4028-9193-f669c66720b6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf94b38b-554d-4a8e-85d6-e3b52805578f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1563820c-e489-40c0-a0e7-c0be60e4bc8c",
"db_currency_id": "5fdd6c9d-335d-4799-9a12-42c9bdf02f60",
"db_language_id": "848e6436-16bf-471a-b4cd-c779c87b93c2",
"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-02-16T22:52:05.1732212+00:00"
},
"modified_dateutc": "2026-02-16T22:52:05.1732212+00:00"
},
"marketing_segment_id": "0ec08c8c-b3b7-495f-90d9-33c254aa3322",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b13351a6-ba75-4b85-b29a-423f78d9ed3d",
"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": "c3ed7b11-49ee-4493-aa98-797d98b8dc3b",
"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": "15dddfe1-8a1d-40cc-a77f-18d4c6e894bb",
"db_country_code": "sample string 28",
"feelist_id": "8b5f441f-0276-49cd-a6bf-6e3e50450328",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa1b6d2c-4ae7-4d18-9ec0-b6de3b19d05f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "73b2b3cb-9a79-4fcd-bbe6-b93cccf6ed8e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T22:52:05.1732212+00:00",
"db_currency_id": "dd77426c-993d-4a94-a69d-d602af6d68bb",
"db_currency_code": "sample string 10"
},
"company_type_id": "f1c89563-3d58-4c90-9b8a-80c85ef969d4",
"company_type_name": "sample string 32",
"company_type": {
"id": "8003561b-6a6d-4c47-b01e-42718e39124f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "245ddadc-a418-4034-b20e-2ef43e69ae1a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "05255176-bd79-4430-af9d-be8bb4c5ab04",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "992f6eb5-6b5a-440f-a599-46bcb00c3c0a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "77fd90b4-0882-4df9-9582-69dfa77103ed",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "99831d53-52ab-4ebe-80aa-aa96aa292d6c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T22:52:05.1732212+00:00"
},
"company_sector_id": "c96c928a-e54c-47d5-84b0-e249d88a058f",
"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": "b807dfc4-75e8-41eb-970d-24a561ad9a24",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d14ad009-2d7f-4c79-8be7-d079a1fde6ec",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cecf4fb3-d9f3-4004-9447-36bb1cc0ddeb",
"account_manager_user_code": "sample string 56",
"company_status_id": "c7720050-ab73-4c8b-9dab-8dc0ada2ec8b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T22:52:05.1732212+00:00",
"id2": 60
},
"db_language_id": "585eecca-d6ca-48c5-ba0a-73a66e698226",
"db_language_code": "sample string 7",
"db_title_id": "f6c83737-20e0-4b9a-8975-cb81859f46c3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T22:52:05.1732212+00:00",
"create_date": "2026-02-16T22:52:05.1732212+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-02-16T22:52:05.1732212+00:00"
}