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": "a60b1f34-d419-459c-99f3-e8da3d80dabe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ab334633-fe4e-4018-bfd1-8c483fb21e09",
"company_code": "sample string 5",
"company": {
"id": "7f19aae6-f1f0-4ab9-bde7-c93d98768271",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-11T13:04:12.2351195+00:00",
"sales_territory_id": "13c54617-f991-4b1b-b201-63a43fd5aacb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f700b0e1-9419-4545-80a4-1e0e03eae30e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "159256ee-c921-4203-a8a3-ec4b00bba4e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "15295def-5e63-4ecc-8521-9fccf89fcc87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca4f045d-a841-4ac0-bfe7-d3ebd76ae360",
"db_currency_id": "30cafb8f-21f3-4576-a31b-6af3dbcb5b5a",
"db_language_id": "3f0c0812-570b-4fd1-839f-986797a6b1db",
"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-08-11T13:04:12.2507469+00:00"
},
"modified_dateutc": "2025-08-11T13:04:12.2507469+00:00"
},
"marketing_segment_id": "7ea2c91a-38fd-4b98-a715-09b6a7ebb82d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "77d7327a-dc92-4f1f-b485-eaaa6e91d921",
"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": "3c04244f-c9bc-4169-9f15-133cd3a2c29a",
"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": "a0a35843-51b3-4bea-8bcc-28a3681d1eed",
"db_country_code": "sample string 28",
"feelist_id": "bede5b04-680d-4f5d-b5ab-7dcc655c7899",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "33ffa4c6-6a5b-4d89-a249-5d4e7de4367a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6e6cda72-8284-4f05-87de-3eba76d2a5cb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-11T13:04:12.2507469+00:00",
"db_currency_id": "29f2eea3-279e-4e5c-a1c5-594449027a92",
"db_currency_code": "sample string 10"
},
"company_type_id": "ad3e36d3-1b9b-4b2f-a11b-ccb7378b6c75",
"company_type_name": "sample string 32",
"company_type": {
"id": "e5a16df4-f9b9-4d17-b8e7-0d4a4501f3dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbb4dbc7-d15f-483f-8ee4-2523b9574923",
"sales_organization_code": "sample string 5"
},
"db_language_id": "96726686-5e5f-4d7d-aef5-32ff1b5f600e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6dd61209-6428-4c49-97f4-0ef0448bcf47",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3d2658f0-5873-42ce-9bdf-720cfcbfcc8e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e0f6768d-e515-4533-b2d1-55a7b74e091a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-11T13:04:12.2507469+00:00"
},
"company_sector_id": "540e03f7-84f2-4f38-a7ab-522f5b68e698",
"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": "c8b44cbe-68aa-4e8d-a38c-f792bfaad676",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "23958747-c640-471b-8c4d-b5135555ab15",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2274c83f-60bf-41d3-bba6-064b8c7a503b",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ac0dc79-0f95-4cc5-8698-c746a1ab1dd3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-11T13:04:12.2507469+00:00",
"id2": 60
},
"db_language_id": "bbaeb2a8-dd5e-4cb1-b7bc-bf710896b3b9",
"db_language_code": "sample string 7",
"db_title_id": "4e642ce5-4ca4-49b5-bb88-d02bf6ccde86",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-11T13:04:12.2507469+00:00",
"create_date": "2025-08-11T13:04:12.2507469+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-08-11T13:04:12.2507469+00:00"
}