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": "a570db7f-1ad2-424d-93b7-79004822f6ff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1bb9e7a1-6f9d-4b53-abd6-0eda2d537cb4",
"company_code": "sample string 5",
"company": {
"id": "9ad26f92-c9b5-4d03-af00-f170128abd9e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-25T17:09:50.5979472+00:00",
"sales_territory_id": "28ec1e0a-0d7d-4ea1-9447-9811f44e3f58",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "84934c5c-dd7e-44c4-a5ce-b412dabe4ca1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a169e21a-89b9-4497-843b-2c8dd2dd9163",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ce53cd8a-88bc-4e6f-aef3-79eaaef97eb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "055aab0a-ab5d-4a6d-87e5-7294af9161cc",
"db_currency_id": "810cf95c-a5d6-415f-9af9-2fcb492b51e8",
"db_language_id": "aa027ed2-f8e9-4042-96ff-b61fe9d612a7",
"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-06-25T17:09:50.5979472+00:00"
},
"modified_dateutc": "2025-06-25T17:09:50.5979472+00:00"
},
"marketing_segment_id": "8be40a43-23c7-4ad0-ae3c-59b0a5a7f510",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "276e052a-243b-4b95-a5bb-0d697bc59459",
"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": "0afd0ff2-eaff-4427-9c39-ef70af7f6f04",
"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": "92c0a280-3529-4421-bf6d-a8408eb3f83c",
"db_country_code": "sample string 28",
"feelist_id": "dedc330b-5805-42aa-81c9-5694eb4b5a44",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6a48af49-d6ce-4dab-bf7c-fceb8e873bd9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4d8acea6-42bf-43a2-b5c2-c7b1dfdb4c89",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-25T17:09:50.5979472+00:00",
"db_currency_id": "5bd1a1ab-4260-4cba-80a4-f485ecd5a02c",
"db_currency_code": "sample string 10"
},
"company_type_id": "f051aaa7-60bc-40f9-869e-86eaa6a7d619",
"company_type_name": "sample string 32",
"company_type": {
"id": "c2ec3239-6531-44c2-9c7e-fb1da13b04d2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b491b03f-821b-4d96-aa3e-6f3278c79ca7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6aac18d9-84d4-4ea4-8757-2878d8d4dc12",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cf1c52c8-70cb-4fc0-a7e8-57f58e1dea94",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e62ab83e-931f-4d1b-a176-1f9f49ad5c7f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8f935dd7-761e-4870-a422-3ab701e5701e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-25T17:09:50.5979472+00:00"
},
"company_sector_id": "f02176a0-838e-4179-bfa4-fd947792110d",
"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": "52527265-9b95-4489-98bc-43df1ddbb459",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "40d7e854-013d-40ee-8592-2ad153f50d7a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "239a854f-8880-4bc5-a38d-8abcf6bf13db",
"account_manager_user_code": "sample string 56",
"company_status_id": "4b9d6738-690c-4cf7-a63e-61b1df99f8a8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-25T17:09:50.5979472+00:00",
"id2": 60
},
"db_language_id": "dd68775e-45f0-4c22-b588-4dade6aa3139",
"db_language_code": "sample string 7",
"db_title_id": "63fd36bc-0e11-464a-ad29-b84f41f69861",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-25T17:09:50.5979472+00:00",
"create_date": "2025-06-25T17:09:50.5979472+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-06-25T17:09:50.5979472+00:00"
}