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": "d41699c4-513d-497f-a273-e8fc572e3e9c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "da269f81-7bc4-4afa-a589-18ffd721e0a5",
"company_code": "sample string 5",
"company": {
"id": "0d389a95-5f7e-411c-9106-11b4e81f2491",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-10T04:54:37.3087615+00:00",
"sales_territory_id": "9debd681-4123-42f6-bef8-acaa74b638d1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "238532fb-3f70-47f2-84fd-8906bee63f05",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dfc5320d-7853-40e8-8853-867ff18c6301",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c85fca47-d6be-4d62-bd0a-2a7b8d867ba8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "444e2b81-7269-49ac-af5c-2b8fcab0ead5",
"db_currency_id": "b38eb59c-0fcd-4f9a-9593-9d0c9794d31f",
"db_language_id": "d465844e-dfa7-46c0-81ce-a9b802db4eb7",
"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-04-10T04:54:37.3087615+00:00"
},
"modified_dateutc": "2026-04-10T04:54:37.3087615+00:00"
},
"marketing_segment_id": "d63c98bb-a24c-4016-a6e7-db7fc07c0f79",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "923c36d9-d826-4308-ba56-5b17749fa0d2",
"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": "5f74e2b8-ab6b-4e72-87a9-48f4403246e0",
"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": "6949622f-07fe-4a10-b659-79f8b609097c",
"db_country_code": "sample string 28",
"feelist_id": "bebd5d3a-2205-4c5d-9608-65b6357624d2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d52cabd6-d6b5-40d9-8074-0b431a46368e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "90cebd0e-5688-482e-a7d5-02f4383cfd27",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-10T04:54:37.3087615+00:00",
"db_currency_id": "e9c1f4e0-efc6-4b39-9a35-24c7588ca018",
"db_currency_code": "sample string 10"
},
"company_type_id": "4d0a6ef8-11b0-4146-9161-b400479607d5",
"company_type_name": "sample string 32",
"company_type": {
"id": "48bfdabe-080a-47d2-a045-bd84600ca8ed",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "71adb930-5dae-41b3-a10c-076612b26dc8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "071fee05-e3bb-47c7-81dd-72f6810bff60",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fb0b040a-cba8-4033-8b82-0a685518c69f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1731d771-ec52-465f-be6b-e312afc80205",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "14c0dd64-443f-46e2-9092-ad51bc6e538a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-10T04:54:37.3087615+00:00"
},
"company_sector_id": "306bd926-75a3-4f6a-bab7-c11f773f7ddf",
"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": "0b82665e-a902-4418-8b70-a01f349081f6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "71980941-535a-4b94-97ee-67c83bc431f7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2fa14243-4cb3-486d-825d-51618592a0f2",
"account_manager_user_code": "sample string 56",
"company_status_id": "3e378780-0ada-4579-9eec-32dcae7b2d0a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-10T04:54:37.3252642+00:00",
"id2": 60
},
"db_language_id": "f4e84a92-5055-48f7-b8d2-de36fa9782ca",
"db_language_code": "sample string 7",
"db_title_id": "6a328021-c3d1-4126-bcff-11e91e76ea55",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-10T04:54:37.3252642+00:00",
"create_date": "2026-04-10T04:54:37.3252642+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-04-10T04:54:37.3252642+00:00"
}