Retrieves the 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": "3dd841c2-3450-4ed1-94eb-edf3f1d55215",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7ea9ecfa-b99c-433a-91a7-95bcd0f9e6b3",
"company_code": "sample string 5",
"company": {
"id": "6cd125e8-bec5-4a0d-9383-fe6ecc1b6895",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-04T08:48:38.1969303+00:00",
"sales_territory_id": "eccf2f55-1c38-4f95-b944-c6062097885d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "620ab5db-e146-4218-8152-375a8e525358",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de0ea549-9b04-4e1b-ba40-e90535e53316",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5f01b261-5299-4a38-aba5-5d14a471bc2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4c25bf9-51c5-4cd2-a40b-2ef85498e8f3",
"db_currency_id": "59afa4b8-0bc5-4cb0-a263-697670087f2f",
"db_language_id": "abcecaee-cd9b-4272-bb30-fb7fc53d55a2",
"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-07-04T08:48:38.1969303+00:00"
},
"modified_dateutc": "2025-07-04T08:48:38.1969303+00:00"
},
"marketing_segment_id": "67f58801-ad52-42f8-8e61-a1712faf94c9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff0bd208-0dab-497d-9334-e2492378cf4b",
"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": "1cf1486d-366a-4d26-81cc-bcf0f17bf97d",
"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": "d78c1b05-4970-4a38-90a4-f8e052fe4cd6",
"db_country_code": "sample string 28",
"feelist_id": "7df5d1af-1868-4919-b05d-349fc188c24f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bba9fd03-116d-4178-ae43-f9e18715ea88",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "505a7dcd-aefa-48e3-9eae-bff3a26a6a44",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-04T08:48:38.1969303+00:00",
"db_currency_id": "6a342b36-6594-48ac-9120-c0596e9f77f8",
"db_currency_code": "sample string 10"
},
"company_type_id": "6e573eba-1fd1-4eef-aae6-a5daf45d259a",
"company_type_name": "sample string 32",
"company_type": {
"id": "db464283-08ad-4d3e-be2a-93e02ec40278",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c5ad2f9f-368e-4bfc-aa34-a82573e93bf3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "321723ff-119b-4e30-ba62-60770f3917c0",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ce8b7b12-d2eb-4b6f-a66b-527a6055ae58",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ec5102d4-edd9-4462-b350-b28e1bdaf89b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2d434056-9e8f-43c3-b2e7-aa29597eebd9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-04T08:48:38.1969303+00:00"
},
"company_sector_id": "110474f4-90b5-4933-8a88-f43840d337bd",
"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": "e6ccaa00-c703-4b65-ac7d-07e1293effc5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a2866f2c-dc9b-4362-88dc-bc18d4db59c1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "00520c6a-8f7b-4c59-97b5-7bcd1f4c8cc7",
"account_manager_user_code": "sample string 56",
"company_status_id": "b81626c5-af12-4390-808e-75d39690af67",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-04T08:48:38.1969303+00:00",
"id2": 60
},
"db_language_id": "fbdb2356-0294-4c29-84e4-b419efd1a1e0",
"db_language_code": "sample string 7",
"db_title_id": "fd1216eb-5dff-4acc-9efa-946a7edd9a20",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-04T08:48:38.1969303+00:00",
"create_date": "2025-07-04T08:48:38.1969303+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-07-04T08:48:38.1969303+00:00"
}