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": "d98a0621-e2f3-4df3-bb1e-8d69c660338d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "279bd71c-134e-4d9f-9b2c-d9c058733306",
"company_code": "sample string 5",
"company": {
"id": "5158d2d8-6878-4c7c-859f-8c8bb012cc40",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-16T05:50:46.7137519+00:00",
"sales_territory_id": "636f8ace-e985-4aed-b6ab-ca7ac9749dd2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1cbb9806-b390-4587-bb73-30d9871b43cb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "812e4f66-fd39-44d2-a0bf-158940a859d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "71976596-9707-4e66-835f-74112e334f02",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2b055d0-d1ea-457d-903f-3b088540f77a",
"db_currency_id": "8f3f95cb-ddbb-4651-9c6f-e8b43cb6fa1c",
"db_language_id": "da65ed24-9449-494d-9d9b-aa9ca5e6fad9",
"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-09-16T05:50:46.7137519+00:00"
},
"modified_dateutc": "2026-09-16T05:50:46.7137519+00:00"
},
"marketing_segment_id": "2f91923f-1d44-4b85-b5e6-522dcdcdbe2e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bf40d192-09c0-47ed-a4af-09010ad4e2c4",
"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": "6db8a7ab-2ed1-447b-a59b-b058871099c9",
"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": "0d51d4ef-6b9c-4a38-90bf-423e0ac821c7",
"db_country_code": "sample string 28",
"feelist_id": "c48f286a-b17a-4801-944b-f5e15fdb5be3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8f8a98d4-82ca-4197-b2f1-2268a85ab981",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d7064274-42c2-4e18-82b9-0d23079fbcc1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T05:50:46.7137519+00:00",
"db_currency_id": "688eb798-743a-4bd7-9555-47b1f1805865",
"db_currency_code": "sample string 10"
},
"company_type_id": "c8a0469a-1c8f-43d5-aa5b-6fcc6481a030",
"company_type_name": "sample string 32",
"company_type": {
"id": "dbb93e2c-ca56-4540-9d06-fb27aa37c470",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f223daa2-b34b-45cd-85cc-60c46b5df61c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1831a562-1251-48d0-af18-ae0b3cb07d1c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "61c49bf8-de8b-4f30-ab03-0417c74215f4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5647f5db-9392-4085-a60c-83d4bdc9b268",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a3ca7321-775a-400d-a05c-14775cf50244",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-16T05:50:46.7137519+00:00"
},
"company_sector_id": "bde10a7f-acca-4cb6-8bde-0c14635a8bda",
"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": "d1db88e9-5c2e-4977-8885-03e18c81db64",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "412561da-baee-4f0b-89ef-052aa21c3cdd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "42b7c08f-8dd4-443f-b11e-547e7b14cb9a",
"account_manager_user_code": "sample string 56",
"company_status_id": "10c95715-18d3-4f43-97b5-5b4ce0904000",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-16T05:50:46.7137519+00:00",
"id2": 60
},
"db_language_id": "6eadb48c-c941-4210-bfc9-bff54216206b",
"db_language_code": "sample string 7",
"db_title_id": "8bdd6aa0-a291-4629-af41-640d3d880a97",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-16T05:50:46.7137519+00:00",
"create_date": "2026-09-16T05:50:46.7137519+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-09-16T05:50:46.7137519+00:00"
}