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": "7f09543c-889a-44b6-acaf-e23d0c182a70",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "81bd380e-d54b-490a-9c25-94e6ad79bbc0",
"company_code": "sample string 5",
"company": {
"id": "8dc59638-0e90-4d9d-8e22-886439ad673b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-30T04:56:53.7828585+00:00",
"sales_territory_id": "e51937af-f6d2-4a0a-ba85-0f0626996df2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a1fc059e-fa99-4d6a-9a99-94f8ba7c7f9d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7d983321-ca89-468d-b186-8385389c8465",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78661ff5-9da9-4ae1-9833-1b41644c2f15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "044fcad7-3458-4189-9530-e4fcebff7539",
"db_currency_id": "c8b51c3c-f239-4f2b-8d1d-96d137713d15",
"db_language_id": "4038a1d0-8b73-49c1-8f75-90fb6ce5bd6f",
"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-06-30T04:56:53.9234813+00:00"
},
"modified_dateutc": "2026-06-30T04:56:53.9234813+00:00"
},
"marketing_segment_id": "51d68d8c-4cac-4c7c-abae-f13703ccdbf0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d9ac3981-8a48-46bb-b9b4-278367be800e",
"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": "d32fd0d3-1a76-4827-bbb2-d11536c9ac06",
"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": "004546be-2de2-4df6-83d4-2b1cf4005a40",
"db_country_code": "sample string 28",
"feelist_id": "977c6f74-1fdb-488a-a015-4122ccf641ce",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a49fbe4-f41d-4e62-957a-bfc567bc59e0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3c033b11-e5cf-4074-9ea2-f99c54e72cc9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-30T04:56:53.9391071+00:00",
"db_currency_id": "40044dad-c505-4b42-b785-ad1cbfd07464",
"db_currency_code": "sample string 10"
},
"company_type_id": "8e303621-74bf-4c71-bced-d983e388f882",
"company_type_name": "sample string 32",
"company_type": {
"id": "3fa3f245-8ad1-41d7-894e-f9b1923c9112",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "398fce58-3ec8-40bd-a5b0-1158aa1d85c9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "38a077c5-f00a-48f9-aaaa-eadde106f559",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e6425c3-f9bc-4cc8-be9f-106245ab5e6d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "75ed4b54-51d6-4a6c-ae84-9df5ca974be9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6e975cba-63cd-4bc8-922f-5cb3752d3c0d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-30T04:56:53.9391071+00:00"
},
"company_sector_id": "dc1ee201-3fab-41bd-91a1-7dfa7d78a4db",
"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": "7f34d9de-1c6a-492b-b8e3-3cf4b3acd9a5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f2f1e16f-4999-4783-aaea-ee6c8db76d67",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7ba68a6c-12a4-4f0e-99ff-a90a45932b93",
"account_manager_user_code": "sample string 56",
"company_status_id": "dc796c61-a0b3-4754-abed-8abe06259d3c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-30T04:56:53.9391071+00:00",
"id2": 60
},
"db_language_id": "83613fc8-70ec-4186-a04b-926794d2e10a",
"db_language_code": "sample string 7",
"db_title_id": "c3c8a759-d58c-4c1f-841f-2afafd0abd27",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-30T04:56:53.9391071+00:00",
"create_date": "2026-06-30T04:56:53.9391071+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-06-30T04:56:53.9391071+00:00"
}