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": "7f49d0f1-bfcd-485a-8810-f1179cf3fc23",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "52c66eb5-ce99-414a-86fb-59b253381880",
"company_code": "sample string 5",
"company": {
"id": "3a2eed2c-032f-4746-a7fe-4fbde0a2779e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-07T10:32:02.3689513+00:00",
"sales_territory_id": "f19ad3f5-7250-4613-9524-a8572c5d06c8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aa87d4b1-409d-4f95-ae7c-fd36d3f8bd82",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9ce74cb8-9a2f-476a-bb82-24c01efc5234",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "83e1ea81-3ed4-4065-bd34-3f0aa47cb252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "394f57a2-b544-438a-ab00-95433603f1e9",
"db_currency_id": "b0d9d9dd-8f1c-41a8-81b5-c9fb2d57ae40",
"db_language_id": "e30bbfa5-5a1d-48b8-bc70-8762a622e479",
"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-11-07T10:32:02.3689513+00:00"
},
"modified_dateutc": "2026-11-07T10:32:02.3689513+00:00"
},
"marketing_segment_id": "6518971b-7620-4d3a-a482-50994c39c2e0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2ddef91f-35a6-4f38-82ed-f647e5cd575f",
"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": "2533e0af-0cd2-4317-b7b0-c867ee2c3eb9",
"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": "7bdb31cf-bd94-456c-96d4-3f0b4964b910",
"db_country_code": "sample string 28",
"feelist_id": "8bd91f97-ec1c-44e7-9bf6-f5a836a1ae72",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "59b15355-8c4b-4b2b-a282-0f7629206cc6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1efe924d-b919-47b1-b249-a5622785f362",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-07T10:32:02.3689513+00:00",
"db_currency_id": "6482938e-008f-4f1c-a71a-0540806d36da",
"db_currency_code": "sample string 10"
},
"company_type_id": "d738a7f4-811e-4397-82fb-c366fd1b88d8",
"company_type_name": "sample string 32",
"company_type": {
"id": "9129a5dc-c94e-4c2d-b03e-b980dea29921",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a57b0857-fdca-4f5d-8a95-d79ad4baf3bd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e8e8f8c2-8cb0-48f3-9746-eca6cb3374f2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "548bb98d-c50c-43c4-93f1-005e02b0037e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8580fad1-a8ba-4892-a7e9-a9a4ed8c3ce3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3b8038bb-b723-434b-8b11-20862c09fbae",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-07T10:32:02.3689513+00:00"
},
"company_sector_id": "e02aef12-d314-4503-b6e0-a6951cb666e6",
"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": "751dd150-f30c-46fc-baa9-fccff3da5fcd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5b2e28ed-05b6-4272-ad11-61e8a76ae9ac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b9e80dfb-6bab-41ca-acb0-41527077fe18",
"account_manager_user_code": "sample string 56",
"company_status_id": "d8b7bd09-1f84-41e5-a840-73650743c7fe",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-07T10:32:02.3689513+00:00",
"id2": 60
},
"db_language_id": "fb579431-7a5b-4daa-9b33-b6e72ae6479d",
"db_language_code": "sample string 7",
"db_title_id": "eaf1dd93-2f26-42b3-955c-51e747655ba0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-07T10:32:02.3689513+00:00",
"create_date": "2026-11-07T10:32:02.3689513+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-11-07T10:32:02.3689513+00:00"
}