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": "361dc241-8337-4403-8a91-e1e8963229a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "382a5525-eec3-46ae-896f-0d7644b85bed",
"company_code": "sample string 5",
"company": {
"id": "258b4272-8d9d-42f1-9175-48e0980efbee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T04:57:53.4371196+00:00",
"sales_territory_id": "7f2d6330-bb58-4427-ae66-cb111e7c4b5b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b47e464e-2068-4dde-8c9e-4fedff05e652",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2dd7dbf-1c25-4357-901c-7d85d6dab7b8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d28dd645-ae45-44ed-8854-4df86573b861",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33e02190-8a65-41e3-9aa2-216bf4faeb8b",
"db_currency_id": "e5a24f19-393d-4aff-84bb-89f218fa7591",
"db_language_id": "29e7dd38-2a4e-4ad3-b725-55138510db7f",
"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-08-12T04:57:53.4371196+00:00"
},
"modified_dateutc": "2025-08-12T04:57:53.4371196+00:00"
},
"marketing_segment_id": "b65d4219-9da4-459a-84a9-d9b9c419c39d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2fe7d587-34b3-4d91-87f4-4c7c8889d0f1",
"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": "5cc06a4a-34b6-4726-b8c4-bea2aa4dfc4c",
"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": "42f4af74-eb3a-4528-9d39-561b176f10c3",
"db_country_code": "sample string 28",
"feelist_id": "2a81e438-7310-4101-afc2-30731f37562a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "02fd9c5d-be60-44e8-be9a-ff292995196a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "50a0b3da-f6cc-4c60-82f5-9fcf4b6b2414",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T04:57:53.4371196+00:00",
"db_currency_id": "ace5c876-98cb-47f0-9521-0c59d12d33f0",
"db_currency_code": "sample string 10"
},
"company_type_id": "4fb50f0b-1d1f-416b-b218-84804691ec09",
"company_type_name": "sample string 32",
"company_type": {
"id": "97fe37dd-137e-4cbd-9bb3-43f77b3121a8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eba78812-28b4-4fd0-b189-e7aadba025c3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7b5222d5-a2cf-449f-a568-173f1788f689",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e0620e4-5e8e-44b5-8f97-2044ca0fe086",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "50324165-acf8-4ef3-9cef-19445bce9002",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5d7fe536-2600-4e4f-9691-e5c482113157",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T04:57:53.4371196+00:00"
},
"company_sector_id": "ab84d30e-89ee-4f7b-83ae-f9e241aa20e5",
"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": "7e775175-5fc1-4ac5-890a-c6e8d7c19735",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b80a7c10-9a0a-44e6-bee2-12b0e98ca819",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2eb888da-706a-427e-b13c-1ac8768a1322",
"account_manager_user_code": "sample string 56",
"company_status_id": "d0fecb91-5521-47e3-810d-b7e3b5fa67c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T04:57:53.4371196+00:00",
"id2": 60
},
"db_language_id": "f0e253a3-6cad-4910-814f-792dc9f05aaa",
"db_language_code": "sample string 7",
"db_title_id": "80bba21a-5875-4d69-bc09-2d8b61349610",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T04:57:53.4371196+00:00",
"create_date": "2025-08-12T04:57:53.4371196+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-08-12T04:57:53.4371196+00:00"
}