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": "068a11dd-89e8-4102-a197-bccdc72b326a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e2b778d6-f244-45ed-bb96-baad6461148a",
"company_code": "sample string 5",
"company": {
"id": "84934031-7ae8-48bd-9663-c7cf610a3675",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-08T16:30:00.6451484+00:00",
"sales_territory_id": "74840401-56e7-4d4d-bb97-a85cd168ed6e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8b860ed9-7c5a-4c21-ac55-9491404309ac",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0bbb31a1-6214-4a27-9afc-95dfff76eb7e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d9439b90-1a3b-4fb8-a910-520c76d2a02c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b3fd75c5-aaff-497d-a27e-886b341a38da",
"db_currency_id": "a4e424a8-288b-4193-bc3e-abe5fb574e47",
"db_language_id": "0692592a-20fc-498b-b8ac-f1f2e8739bdb",
"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-01-08T16:30:00.6607699+00:00"
},
"modified_dateutc": "2026-01-08T16:30:00.6607699+00:00"
},
"marketing_segment_id": "491ca936-5fab-4000-bebd-4428d2a7874c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "747bd790-8d18-4d89-b439-7754a7063eca",
"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": "9c17e6a9-cc9b-4e81-b405-14e5b63e461a",
"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": "882a7cdd-dc99-4333-80a2-99b75f374f27",
"db_country_code": "sample string 28",
"feelist_id": "cbbfbf4d-e416-4e14-8919-57085d957f3f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5593404d-1bae-462f-8b1e-142b61dd3eca",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5c4bed99-b163-4fb5-854e-d9a82519b100",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-08T16:30:00.6607699+00:00",
"db_currency_id": "21b21bf8-fe13-493e-af66-bca849ef3d48",
"db_currency_code": "sample string 10"
},
"company_type_id": "e1133e07-23cf-4b7d-8cb5-3423012aa071",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae7a538b-6574-4fef-a3ad-85a853f2c767",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aef70df7-ed06-42d4-83bc-6edeb6684a0a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "74f385ef-be31-4f69-89a2-c904c76cbab8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "220591ce-ecd5-4836-b995-baa40d593262",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2d3f2ef-e1df-4d94-acd6-a2b5913d5186",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d8e0453a-b08d-43ed-9745-ab2730e29814",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-08T16:30:00.6607699+00:00"
},
"company_sector_id": "7fc4207b-8bde-40bc-a0af-12362df1c6bf",
"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": "a7d2cd36-d526-465e-b436-7465f600d100",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "36401111-5b57-4349-b222-9d86e9a3e0a6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1263d404-0e95-4fb6-bfa7-e9b58cb9a813",
"account_manager_user_code": "sample string 56",
"company_status_id": "970f4643-7b7d-4896-84b6-dbbbe6cd9cb2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-08T16:30:00.6607699+00:00",
"id2": 60
},
"db_language_id": "04cde974-3b7b-4e08-a230-621707cd0bf6",
"db_language_code": "sample string 7",
"db_title_id": "3db42c2c-3c60-4b86-9aad-fec5a38ce6aa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-08T16:30:00.6607699+00:00",
"create_date": "2026-01-08T16:30:00.6607699+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-01-08T16:30:00.6607699+00:00"
}