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": "e6e29081-8289-48bb-b01e-8f0c53c54da4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c0cb1cb1-584e-443e-b7f6-b98f0a08fcb9",
"company_code": "sample string 5",
"company": {
"id": "6d40350b-630e-4a8b-83a2-8fa0cc4eb287",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-25T03:46:59.9474688+00:00",
"sales_territory_id": "0a0f3316-aa77-4df9-953c-2fb87ded0b14",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9bda69f0-dc59-46f8-8bde-4030b7125e03",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "abd6abe3-3b23-4294-93f0-7c1f9a39e8e8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e6ad63a9-1386-4c6c-821e-c09d1546bea0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ddfcea52-4ab2-4436-a414-4394e5632cb6",
"db_currency_id": "39e780fb-945e-43bb-8c28-22b9d1dfdca5",
"db_language_id": "50a99225-683d-44a5-a3e2-8f1347ef8289",
"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-25T03:46:59.9629183+00:00"
},
"modified_dateutc": "2026-02-25T03:46:59.9629183+00:00"
},
"marketing_segment_id": "63a2b9ed-3075-4971-9862-b7b6d80a1b6b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "04847b06-1924-4465-9e98-3845e666c2d6",
"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": "9dc3d8eb-9867-45d2-9784-5214617bb413",
"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": "377688cb-cacd-450a-8799-0ff23d22db6a",
"db_country_code": "sample string 28",
"feelist_id": "dd80711d-95bc-4c1f-9ce7-a62999b65927",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bed90dcc-88f1-4112-8f10-933dc78258ef",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "812e1a02-02c2-42f1-b55a-c7410fcf77b4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-25T03:46:59.9629183+00:00",
"db_currency_id": "18c3c1e5-6a82-4b1d-b80a-43b2bbdb59e6",
"db_currency_code": "sample string 10"
},
"company_type_id": "c926efc0-b0ed-47ce-8a80-7ae9453b1771",
"company_type_name": "sample string 32",
"company_type": {
"id": "9bbb055a-48d1-4dae-a00f-98916c8e4b3b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f09a4aa4-c905-45b7-8444-9af7214d08da",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b21d2977-1398-467e-983b-ea595f2878b7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e38dc0e-23b1-4014-aaea-d94e523441de",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1bcfe7a6-050e-4c42-b50f-eda72b07ab8c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "95abe170-c2c7-4200-8d73-97131944b4cc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-25T03:46:59.9629183+00:00"
},
"company_sector_id": "47f615fa-1af5-4c1e-b67f-e4e279c73ac3",
"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": "7827beea-2af3-4c8b-8f77-4d71980d9364",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "67bb055d-22d8-471b-ab96-80c3f32b046e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fd4cf89d-1c18-4c4d-8d93-e40da4fd9f83",
"account_manager_user_code": "sample string 56",
"company_status_id": "bdd3c43e-55c7-4987-b663-3aae89e9e0fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-25T03:46:59.9629183+00:00",
"id2": 60
},
"db_language_id": "a3631dd1-b805-4db7-a6c2-2d6e3d03a9ee",
"db_language_code": "sample string 7",
"db_title_id": "402033bd-a0e2-4c7c-858f-730795853aa5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-25T03:46:59.9629183+00:00",
"create_date": "2026-02-25T03:46:59.9629183+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-25T03:46:59.9629183+00:00"
}