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": "e7d31926-e2b1-4921-bad1-efa7186a1e6a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b90c651e-bfb7-40a4-b16f-1964c5b75221",
"company_code": "sample string 5",
"company": {
"id": "c2a9f091-c216-42b5-bc4b-69d3ed7a4bf2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-11T14:16:33.5547546+00:00",
"sales_territory_id": "2f04762f-52b6-47bb-aeca-61e52803ab93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "083dc235-f935-415f-9d47-e42562ff25b5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e1bb0134-4057-4a4a-ad1f-76a142e7c5a0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a0b21154-a37a-4401-ac80-15d88e79fb1c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a77ec28-2b50-40c6-bd5f-ab1ae4df6f83",
"db_currency_id": "72cb9f44-178c-4291-b6e9-7e684869344e",
"db_language_id": "54055d24-1d39-4659-a656-4711b8862d7f",
"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-06-11T14:16:33.5547546+00:00"
},
"modified_dateutc": "2026-06-11T14:16:33.5547546+00:00"
},
"marketing_segment_id": "99e694c2-bfac-4802-be0c-853f39f62cf2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "45eca5e9-91df-4dd7-9f32-391ee0fcdc6f",
"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": "b8d80d52-d397-40c1-aa13-7755467ab5fc",
"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": "b414a148-56d5-476a-9f80-83f641c5a71e",
"db_country_code": "sample string 28",
"feelist_id": "c3262180-49b3-4767-a131-9855dc2217ef",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5c8170a2-b359-4ae7-a4ed-9ac02ead1ca9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "62411d07-1c79-4b52-893a-3d8b7bad94b1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-11T14:16:33.5547546+00:00",
"db_currency_id": "7ae7b8eb-ce25-49c5-b4bf-2df98ffe5e6f",
"db_currency_code": "sample string 10"
},
"company_type_id": "4ad52748-360b-453a-a440-9a8a9278ed16",
"company_type_name": "sample string 32",
"company_type": {
"id": "8d5de601-9b40-41f9-a2e3-8398446c1348",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e298458-ce31-48b7-8bf7-0275e11e753b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2b999f2e-841b-4343-b65e-d0155817ed93",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "049d6004-855e-415b-8924-9914eec04c66",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e0d4b4a8-36b8-4553-a2bf-afd76e03bccf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8954e118-a6fc-4e75-8625-368de59abd7e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-11T14:16:33.5547546+00:00"
},
"company_sector_id": "4be61474-ad37-4d0b-b2d0-8e80851b2d7e",
"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": "026143c2-d89f-48ec-9fde-0b2d2e3dbb70",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0d383e20-720d-4ab3-8171-d7c62ee321f0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3342a900-df3f-4a89-9c6f-08ddd8b41a89",
"account_manager_user_code": "sample string 56",
"company_status_id": "53e7c13c-dd49-48ed-90b2-820b2781c107",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-11T14:16:33.5547546+00:00",
"id2": 60
},
"db_language_id": "3c66cb69-84af-42b8-b3ff-f340104ba605",
"db_language_code": "sample string 7",
"db_title_id": "cbd54c34-a8fa-4cde-864a-c006fcea2ee3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-11T14:16:33.5547546+00:00",
"create_date": "2026-06-11T14:16:33.5547546+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-06-11T14:16:33.5547546+00:00"
}