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": "33d7d282-b059-4172-a177-f48713037a13",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f18e3863-bd60-4e68-b2b8-7bac15c1cb8d",
"company_code": "sample string 5",
"company": {
"id": "304c18eb-10f7-430e-a20d-89ad747888e5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-21T01:51:59.3059165+00:00",
"sales_territory_id": "2458eb8c-6251-4b44-85c3-44ddfa75f4e2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "51cdd0d1-e155-46e9-baa0-c1e29d0b2a47",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd79051a-44fc-4ad3-827a-26a14a199c0e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "73ee7a09-05ad-4f93-9097-309b3320b952",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d9383927-ba70-4742-932c-4a1417a1376c",
"db_currency_id": "1b1d96f5-0225-40ad-8a4b-4b1e90ddb2d8",
"db_language_id": "774a6881-d5a2-4c3c-85d0-b7ff7c699c89",
"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-02-21T01:51:59.3059165+00:00"
},
"modified_dateutc": "2026-02-21T01:51:59.3059165+00:00"
},
"marketing_segment_id": "b2c778aa-0437-4c44-a0d5-fdc39f1bf7c8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dba39385-fadc-4408-9a5b-a7349a8a0058",
"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": "d5fda5d6-794e-48b1-b9c7-b757e2a3e974",
"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": "0f94468e-b4f5-4b4d-8fe4-056ed6411c96",
"db_country_code": "sample string 28",
"feelist_id": "46959a21-a93e-427e-8aa9-c6b68944304d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8f4272ee-b1aa-4731-a385-5ebd2e7c336c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4d4cf349-b161-4e88-86e8-9da257875c22",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-21T01:51:59.3059165+00:00",
"db_currency_id": "68d933d3-d241-45dd-a657-78bea0044a0e",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2e8abe8-e79d-4aaa-9db2-b712ebb1a946",
"company_type_name": "sample string 32",
"company_type": {
"id": "710ea8cc-76bf-472d-86f4-e81f72bdff87",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88eef50f-d41b-42a2-8004-d15b575141e9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b69483d7-1665-4df1-ba38-eadbe7fc7168",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bd06cc13-8b85-40b3-8f9b-ecc8a074b883",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b723c890-abff-4f0d-b970-b3528b753d42",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "60b248fa-5f24-48da-99a5-5951051eb915",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-21T01:51:59.3059165+00:00"
},
"company_sector_id": "a7b7cb4e-8555-436d-9658-faf44811d358",
"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": "71dd8d4e-93a0-4a49-91af-557a8e592309",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "67eea8de-efa7-4f3d-918f-a2f83a615407",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a43846bc-1dae-4c6f-a29a-1c04618e6bd1",
"account_manager_user_code": "sample string 56",
"company_status_id": "fdecf887-d3c5-4c91-82f2-da0ab537e822",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-21T01:51:59.3059165+00:00",
"id2": 60
},
"db_language_id": "a79cf392-dbea-49cd-918d-43b1bec4ccfb",
"db_language_code": "sample string 7",
"db_title_id": "d5ad4c3f-ca5c-4708-b21a-ee27b3200424",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-21T01:51:59.3059165+00:00",
"create_date": "2026-02-21T01:51:59.3059165+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-02-21T01:51:59.3059165+00:00"
}