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": "89448f50-c57a-4da8-82fc-fb06592fe356",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d9af8d05-6db9-4a8f-809f-85a1bfbba237",
"company_code": "sample string 5",
"company": {
"id": "b9279e02-a3a9-4023-a4ce-64daa56e9ec6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-16T12:00:32.955451+00:00",
"sales_territory_id": "d7d49951-7c04-45e1-96d1-d93c3a5cdb01",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1c6e5884-7e6a-4a4a-b30c-9d837b98c5da",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "94761a3f-0291-4887-b209-ed0374cffb54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d85d5637-adca-4dd7-9119-4e5be01275dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "579cfe36-8b96-4fb4-959f-fde18783076b",
"db_currency_id": "385427cd-7859-44d3-b61e-0a16b60d1a88",
"db_language_id": "a4f024fa-fb0a-4cec-af5b-513274d115c7",
"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-11-16T12:00:32.955451+00:00"
},
"modified_dateutc": "2025-11-16T12:00:32.955451+00:00"
},
"marketing_segment_id": "1ec03343-6dff-4f33-b4d0-bef04e9470e0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35df25c7-0aa9-44e2-9474-156eaf8a59d6",
"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": "43df9bd7-c948-49cc-801d-f5b6d8c27b34",
"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": "bc0740cf-de50-473c-ba2c-76958ef29b98",
"db_country_code": "sample string 28",
"feelist_id": "06b0c376-0608-4db2-b7fb-3264eddf86bb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3d6ce639-1a40-451a-8e41-10752d1ba6d4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "def5047f-8884-4f87-9e60-d38f42cd1f74",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-16T12:00:32.955451+00:00",
"db_currency_id": "1c76c95e-bf0f-478d-8e40-b7607f811d39",
"db_currency_code": "sample string 10"
},
"company_type_id": "aa8742dc-9583-490c-8d04-e5f722de8d58",
"company_type_name": "sample string 32",
"company_type": {
"id": "848768e9-2109-4681-850b-eef1625dd730",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "121227db-f968-4bd9-a161-b842527c3859",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fbac2e52-5394-4d03-88ff-a73a1004e5d4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6cf6cfc2-76d0-41df-b336-50bf01a9da30",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4cd85555-7868-4263-9538-a656da646742",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "aa0b7571-1e99-4016-abcb-b7d2c94390d4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-16T12:00:32.955451+00:00"
},
"company_sector_id": "013a6999-3b09-4671-bbf6-12db853f8004",
"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": "741bf0e2-a4c5-43b2-927f-ff09baa86d07",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2ccc757a-4caf-445c-97d1-692261073099",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "98411ed0-d375-4204-a677-7c08d7c8f58c",
"account_manager_user_code": "sample string 56",
"company_status_id": "8c72fcef-b249-40fa-8d16-bf9f6ad83430",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-16T12:00:32.955451+00:00",
"id2": 60
},
"db_language_id": "d5b4d16a-ae08-4a7a-8fcd-7b22dcf8b0bf",
"db_language_code": "sample string 7",
"db_title_id": "34074b1e-0dd9-402c-9839-d3e5dd3f5e65",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-16T12:00:32.955451+00:00",
"create_date": "2025-11-16T12:00:32.955451+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-11-16T12:00:32.955451+00:00"
}