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": "6a986a94-9cbf-4292-b51a-72ad45bb2a55",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2a443bb8-da5d-4ec4-ad33-b905acf3cf63",
"company_code": "sample string 5",
"company": {
"id": "134f5fa8-30bd-4ef6-b46c-915b1d74b6bd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-22T17:30:24.4335925+00:00",
"sales_territory_id": "14388450-79a4-4950-ab25-cbc764a2eaed",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e25faba5-7e43-4270-b598-455d7c176887",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a44ff9e8-8558-44d9-b459-a87f143e8a2e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "da58336b-cd0b-462d-b1ca-19e2f0fb028e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecae04d8-d6bd-481a-96c2-07143e4ea9dc",
"db_currency_id": "b3b6504e-26f6-4e1a-acef-770b0f37d71c",
"db_language_id": "e0c1d533-7409-40d1-a8e6-646634dcdb21",
"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-11-22T17:30:24.4335925+00:00"
},
"modified_dateutc": "2025-11-22T17:30:24.4335925+00:00"
},
"marketing_segment_id": "378b052c-0581-4396-b37f-fe3d129ee787",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "54946138-45da-44cf-9cfb-02bacca81081",
"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": "bb56f392-f89c-4126-be29-d5a7d88437ec",
"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": "0da0994a-0fe7-4a51-93b8-c6772760c59b",
"db_country_code": "sample string 28",
"feelist_id": "4c3dd10a-4e6d-4eaa-ac70-931f2a6a5340",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "15d6e7db-44e7-4479-a711-89ba26a96c17",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d57bbadc-a7f7-4b2d-b25a-2d914d63031e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-22T17:30:24.4335925+00:00",
"db_currency_id": "13190c17-697e-41f5-95c4-30a5287ed45c",
"db_currency_code": "sample string 10"
},
"company_type_id": "0dfd00d6-76c4-4597-bafc-27c85ee5e069",
"company_type_name": "sample string 32",
"company_type": {
"id": "73b2e4f9-9a24-43f1-89a9-0193e6480201",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c6465228-b40d-4132-aad3-6440c79f2791",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fea88e2b-a968-40af-86ae-7f58501fde63",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5c243740-de03-4950-9cd0-4085a2de592f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1bdf9242-9079-42d7-8366-01a9f57ecded",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7bc58101-8081-49f5-a294-14134c3ffa6d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-22T17:30:24.4335925+00:00"
},
"company_sector_id": "7b2e50f5-5075-44a4-9269-607a44edccd2",
"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": "7cd54879-fb2a-4edc-9cb1-8d1393718ff4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "84804187-a851-443c-a296-a742a70a6dd1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "863730a2-127b-406d-ad40-0995eb5671d5",
"account_manager_user_code": "sample string 56",
"company_status_id": "7c530387-3ce2-44d6-93af-379c3bbf53ab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-22T17:30:24.4335925+00:00",
"id2": 60
},
"db_language_id": "9e2d58e4-cd98-4e6e-ae77-b250b08a17ad",
"db_language_code": "sample string 7",
"db_title_id": "8e083cf3-06ad-4e23-9c22-6d0afd183b44",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-22T17:30:24.4335925+00:00",
"create_date": "2025-11-22T17:30:24.4335925+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-11-22T17:30:24.4335925+00:00"
}