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": "fe8d7793-2dd1-4f46-8278-1e0af0553b69",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a76ce9b9-ac74-44bd-9030-fb936f54bf76",
"company_code": "sample string 5",
"company": {
"id": "b2d0e09f-5a91-4c70-a11c-fc80e9b04f28",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-23T10:47:19.7879327+00:00",
"sales_territory_id": "cedfbb9f-8ea5-4aea-989c-b80bbb81ec9a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2df6da57-eef8-41e1-bb90-3d1bc2050619",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b115a5de-ece6-4281-89d9-2e2b3a684c07",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08631173-b70c-4c55-a42d-5f007e1181b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0e4ba32e-9221-4659-8c03-855f2e24d087",
"db_currency_id": "86ab3da2-24af-4f98-aebc-9dc73e580f5b",
"db_language_id": "9e678378-e93b-4219-b13e-9235a4403ec8",
"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-09-23T10:47:19.7879327+00:00"
},
"modified_dateutc": "2026-09-23T10:47:19.7879327+00:00"
},
"marketing_segment_id": "34f6a3f6-1d7f-4524-bf5f-5e77374f0230",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b881544b-bf71-487a-9589-9e7587084eb1",
"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": "014da413-151f-4447-88b5-c11d58322be6",
"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": "0c9bdb2d-b973-4037-a19e-2b6a49b09418",
"db_country_code": "sample string 28",
"feelist_id": "6faa0c65-f68f-45e1-97b3-26c864c22e05",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e64e9fb7-c21f-4a14-9995-1db2df1a6df8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c6a02b1d-2faf-4a53-be34-be55d9e1b8e0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-23T10:47:19.7879327+00:00",
"db_currency_id": "f4d28179-2460-472a-843e-7c24fdd395ee",
"db_currency_code": "sample string 10"
},
"company_type_id": "b4b4e360-7033-4221-a5a5-e26559d47882",
"company_type_name": "sample string 32",
"company_type": {
"id": "c4eeafc4-4db2-4cea-b0c1-d370b983c9ed",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4dbcdfb2-e824-441d-86a6-5e041de523a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c7a59eb-c702-4376-a152-b62f02159ec4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b2ada83d-960e-49b4-9f23-3ba0df25c9cd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "01061552-2eca-4ae1-a4ec-94a9534fc344",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "de7e5bc7-1d26-4bde-a799-92c933ad1cdb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-23T10:47:19.7879327+00:00"
},
"company_sector_id": "5e075889-72d2-4328-907f-e358513511bd",
"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": "8c56de3e-5cc2-45b2-9de2-63730ea8bd76",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "02a397fd-be6b-48e6-84ac-ca41e156d07e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8d988b9-40db-4025-aef4-7105a981ae84",
"account_manager_user_code": "sample string 56",
"company_status_id": "c0a77e0d-2ca3-4717-8daf-78b5fa8a00fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-23T10:47:19.7879327+00:00",
"id2": 60
},
"db_language_id": "0691fc7c-59f4-4b65-8204-3db8d14b00a5",
"db_language_code": "sample string 7",
"db_title_id": "f51e45de-d696-4d7a-a92e-c5133ac40f08",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-23T10:47:19.7879327+00:00",
"create_date": "2026-09-23T10:47:19.7879327+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-09-23T10:47:19.7879327+00:00"
}