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": "629dbbd5-12cf-4347-9497-03e91a3cbe4f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2434d305-1888-4363-a3e5-d560f1fde104",
"company_code": "sample string 5",
"company": {
"id": "4b5dfda8-83d6-483e-8c52-e47cd5621f06",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-07T18:57:32.5126044+00:00",
"sales_territory_id": "d403172f-6686-467d-8739-ff64bc04461c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "72939076-7611-4279-b8b7-60b4b3e11cc1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a17c2a4-6d1d-456e-be11-901c11c02e12",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d746797-3a51-4ce8-906c-9b65fddf2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a139a883-0ef0-45b6-8fdf-84d28b837d4f",
"db_currency_id": "e79eb18b-e8d0-44f4-b258-e84677cd8fc7",
"db_language_id": "092ba7a2-db90-4464-8c6f-200595b80f6d",
"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-07T18:57:32.5126044+00:00"
},
"modified_dateutc": "2025-12-07T18:57:32.5126044+00:00"
},
"marketing_segment_id": "f755d3c5-9175-4914-ac74-8e0b83a85d6a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "de5ae70d-5c77-4e4c-b3ed-510e400db24e",
"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": "f4a6dca9-df63-4058-a6f0-087965c2686d",
"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": "b255f8a4-8444-48eb-8c36-1d941d0a2689",
"db_country_code": "sample string 28",
"feelist_id": "b77bbc36-6e13-48f6-8d73-8446520bd057",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "822661ca-4b70-4861-abe1-705fdc495fa5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "84f817cc-2731-465a-8682-d50daaa09fe5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-07T18:57:32.5126044+00:00",
"db_currency_id": "2992351e-76b6-4c8a-bc66-60d507095b2d",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf358d58-47f0-4dc0-bd7f-345db07e51ae",
"company_type_name": "sample string 32",
"company_type": {
"id": "c28b6db7-f3a0-44a0-9f33-adbb15ff8652",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ec5ddcb4-0aa2-48b2-b175-c59c7e69b9ad",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a2fceb70-9e66-400e-8b9e-797f99b52b58",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "edf8f273-c1d1-4bf2-89ea-e1b6f9ed629b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8d79d6e7-8bfa-498d-8a48-e282e806830d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1bd0a29b-1358-4973-93e0-af2c83356ab1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-07T18:57:32.5126044+00:00"
},
"company_sector_id": "304e918e-1c65-48bd-a278-9367d9babfa7",
"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": "8a71195b-2009-4a2e-b3b9-0f171553622e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "70e3459a-6ba2-46ae-b20e-ebc503d15819",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9b60a15a-e8d3-4f28-b7c9-11a9be9edc50",
"account_manager_user_code": "sample string 56",
"company_status_id": "b02092b0-1083-4a27-a37c-a8c2771f92c1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-07T18:57:32.5126044+00:00",
"id2": 60
},
"db_language_id": "4d881d8d-e5d2-469d-bd7b-49d7673db0b7",
"db_language_code": "sample string 7",
"db_title_id": "65f3b5e7-1fc7-45ac-940f-3a31b88ce94b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-07T18:57:32.5126044+00:00",
"create_date": "2025-12-07T18:57:32.5126044+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-07T18:57:32.5126044+00:00"
}