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": "0513cc67-d495-4b70-91ec-4aa1ce9e1005",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c3c341c0-ad52-419d-b2a8-74fc34ff2ccb",
"company_code": "sample string 5",
"company": {
"id": "0d2bfb0d-f8a0-4307-bbc5-963a1de76b9b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-01T15:01:14.8138955+00:00",
"sales_territory_id": "f5eaa5cc-bc1a-4b3b-bcba-cadee135c776",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b4f8d770-0b14-4878-8dac-48d299371256",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1498244c-d9e9-4403-8f56-d2cd27416d55",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7359f339-64cc-4fff-897e-a10b97feb92a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da1120ae-62f7-4443-862d-bde0b2c46772",
"db_currency_id": "1060470d-b265-4750-9183-51e661ff1d23",
"db_language_id": "b2db7e03-872b-4d71-8d41-a62c833b6db1",
"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-09-01T15:01:14.8138955+00:00"
},
"modified_dateutc": "2025-09-01T15:01:14.8138955+00:00"
},
"marketing_segment_id": "34799e72-89a3-43b0-aa8f-86b8cdc68e34",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2be97203-0193-4387-97ee-93b73e3bf882",
"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": "81ed758e-08a1-4c77-98d8-ba1de07f1d0a",
"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": "21297aee-3a89-4663-aa3b-87866e002827",
"db_country_code": "sample string 28",
"feelist_id": "06599a3e-4195-4691-9d5b-973b2fcabc82",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1c88f9bf-d855-454b-a9c7-bcc5c404f20d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "debfbee3-21ab-4896-983c-fc33bd0aa4c9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-01T15:01:14.8138955+00:00",
"db_currency_id": "5de9f8cb-6f9d-415b-ab25-d02ca6602af9",
"db_currency_code": "sample string 10"
},
"company_type_id": "47bf73ec-1291-4543-96f0-b568c7bf59e2",
"company_type_name": "sample string 32",
"company_type": {
"id": "b57e9573-870f-4143-94ab-75da0f7cc2df",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "92a08a32-858d-4478-8856-f23f5c59d786",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c00d464-b6d7-4d00-9412-7fc96ce5505e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d45de96c-a603-45cd-b08b-0deb7548ee3b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "034e9d4a-5170-44e6-9a5f-34d77740ae95",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f6e2fa79-573f-4eb6-b9ce-85e0ab956120",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-01T15:01:14.8138955+00:00"
},
"company_sector_id": "dcf4b966-50ac-42df-9fde-ceaeb7eb3aff",
"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": "9ff5bed0-6260-4e41-a9f5-c967b0494579",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7ed52237-1936-41c8-9078-8bef1d5eca55",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4933c977-8057-47f9-bf75-4ad0477415c8",
"account_manager_user_code": "sample string 56",
"company_status_id": "c75e4f1e-a16f-4c24-b3ae-a3fefdb22197",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-01T15:01:14.8138955+00:00",
"id2": 60
},
"db_language_id": "fd65732b-1cc3-43b8-a564-e18997149f25",
"db_language_code": "sample string 7",
"db_title_id": "b1f05334-f7fe-43cf-8ba6-b5c712bf2d6d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-01T15:01:14.8138955+00:00",
"create_date": "2025-09-01T15:01:14.8138955+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-09-01T15:01:14.8138955+00:00"
}