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": "3f9386af-d1d2-420a-9496-6bce92598dad",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "614515a5-d5b8-4012-b5b1-304e9da96090",
"company_code": "sample string 5",
"company": {
"id": "e7c40874-7188-432b-8956-d74313dad554",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-24T11:00:02.653092+00:00",
"sales_territory_id": "7dfb21a2-5e2a-459b-8739-19f4fed1daa4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8b3790bd-47eb-4ed7-ad34-af1c99b233bf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b1e57ee-3351-4ee7-ada0-306f92d8f6f5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c454476b-df65-481a-a02b-2eb9364da32d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54344f72-7a8d-4703-8771-072c3c1029aa",
"db_currency_id": "6527dbde-5315-4ce9-98f7-51ed6dff254d",
"db_language_id": "f879a925-1f5d-4dcf-9a2c-d4583c59952e",
"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-04-24T11:00:02.653092+00:00"
},
"modified_dateutc": "2026-04-24T11:00:02.6687105+00:00"
},
"marketing_segment_id": "157f44a4-4a2d-4301-a0ba-20f2d657580b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff1199e9-deb4-488e-b9c2-a2981969f8ce",
"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": "1f5f1d38-2469-480d-b631-c70052bf82e5",
"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": "125ba987-cd2f-4db3-a49b-c19152864b53",
"db_country_code": "sample string 28",
"feelist_id": "6a30e20b-c2f0-4c4b-8d66-0b803487c5ee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bb030abc-e160-4c21-84d3-7b2e8b0f7737",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8e9f9120-d81a-48d2-9fe3-430a61fd5258",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-24T11:00:02.6687105+00:00",
"db_currency_id": "77b00f06-03f2-471c-9139-48980d84b0b6",
"db_currency_code": "sample string 10"
},
"company_type_id": "054059c1-99f1-42d7-be0e-2c3eb194fa04",
"company_type_name": "sample string 32",
"company_type": {
"id": "e7f2750a-8bcc-4cf8-b00c-edacff17e0ec",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85bca181-c092-43c6-a449-5b894b2d7f8d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "13ffd423-a4ea-4005-8fad-e7d4bc75d9a6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "93f38c57-e6e7-4980-85ba-6a4b1eb65183",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e81a7148-410c-4f2f-b759-cd21b01fd026",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "53b97ee0-cb22-454b-a061-18f45ecc80d7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-24T11:00:02.6687105+00:00"
},
"company_sector_id": "ef1e374d-34cf-4b5f-9f47-a1ea70ada4de",
"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": "d92f67ee-09bc-4f0b-94e6-da5d9d768419",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f48c643a-7a5e-4425-9e7b-a02a2978e426",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "68a82475-b8cc-4546-8aa4-df274b8e52e8",
"account_manager_user_code": "sample string 56",
"company_status_id": "7216a1ce-ba29-49a8-b755-637efb904329",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-24T11:00:02.6687105+00:00",
"id2": 60
},
"db_language_id": "a8026144-dfee-4f13-9d24-8e0a523f4b02",
"db_language_code": "sample string 7",
"db_title_id": "59ff5d88-0fef-4b58-956f-a1bcdb41fa71",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-24T11:00:02.6687105+00:00",
"create_date": "2026-04-24T11:00:02.6687105+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-04-24T11:00:02.6687105+00:00"
}