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": "ab648c78-dc3e-4993-9835-888b3636a311",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "84c358c7-4a5d-459a-9006-f38cd516790e",
"company_code": "sample string 5",
"company": {
"id": "66eb931e-7b1a-473f-84c3-a9d83249df9d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-22T11:39:51.3062338+00:00",
"sales_territory_id": "42934378-cef9-4d24-96fa-0f4e283bb303",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "77c437c4-e3d0-4494-af55-b3b30b807288",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b17452bf-798e-4215-bb8f-00a3d85597e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e85c915b-842b-4503-86af-1fecac5b8a56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf469ff-95c5-4734-9188-e3f0daab0ff3",
"db_currency_id": "e8277417-6b88-4b7f-a368-94faae65cfdd",
"db_language_id": "36b3544c-e9d6-4566-87e0-9234db96b78e",
"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-07-22T11:39:51.3062338+00:00"
},
"modified_dateutc": "2026-07-22T11:39:51.3062338+00:00"
},
"marketing_segment_id": "b5a86deb-dff3-4471-8aec-894c0ce94b5c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "60a033c7-4b24-4edc-9998-0ab8ffde6596",
"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": "1a9aa6be-5994-47f2-9574-1b35b8368e5f",
"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": "7cf805c3-77b8-4b2d-a573-f35bb48c7d85",
"db_country_code": "sample string 28",
"feelist_id": "28df892b-7318-48a5-82a2-c2b5057c5368",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e815cd2b-f63b-41e8-8dd0-19fee14cd37c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "abd287b1-ebee-4cea-be84-bb4f791b7165",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-22T11:39:51.3062338+00:00",
"db_currency_id": "34f01c1a-d866-4f88-b16f-e575d061b476",
"db_currency_code": "sample string 10"
},
"company_type_id": "358dcdfb-1a7c-4145-b13f-8bcc858f07de",
"company_type_name": "sample string 32",
"company_type": {
"id": "dfeac6ac-f0a5-4176-a2ba-fb8164d969d4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f8e6d38c-bd6b-43f9-bd4a-93e0d6b9e5d4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eb8b6648-ecee-48b1-988c-f90f8144de02",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2c6d00b8-0778-4f4f-ac1c-937732434aa5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "94fb7ccc-863e-42ea-b059-aab3d79426dd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2c9ad689-937d-4ca1-a30e-26b525240386",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-22T11:39:51.3062338+00:00"
},
"company_sector_id": "6cd284a7-872a-45d1-9cc5-2c0d475c2c14",
"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": "389aa2b9-e0e7-4c34-960f-01d8b10d81af",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "857a47b6-6fc4-4e7a-baf6-f484eccb8602",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7becf5d6-7c24-4018-b858-4594dbfd0cec",
"account_manager_user_code": "sample string 56",
"company_status_id": "f6eb784f-1eaa-4270-b08e-fd8d46fde846",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-22T11:39:51.3062338+00:00",
"id2": 60
},
"db_language_id": "bc831209-b418-442b-9ef6-f93654c5f62b",
"db_language_code": "sample string 7",
"db_title_id": "32795cc9-b4a4-4ae0-aa5a-810945ddbd8b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-22T11:39:51.3062338+00:00",
"create_date": "2026-07-22T11:39:51.3062338+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-07-22T11:39:51.3062338+00:00"
}