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": "156fc7d4-eb18-47bf-8179-1f15d3823ca7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a9f9caa3-4271-42de-913e-b7f1502811e2",
"company_code": "sample string 5",
"company": {
"id": "a4817b11-e0b1-4394-bb79-b1b620ae3088",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-24T04:50:47.3570301+00:00",
"sales_territory_id": "550aff54-ef5b-4614-a01b-8ae49fc116c1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d95db743-ddac-4b0e-9b4c-b243d62f08bc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3cfe69bd-9830-4098-a650-ba36eb82f453",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3dd11aab-8826-4eac-ad00-a951b163f899",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f982bca9-80b1-4b09-9f39-eb340386dfba",
"db_currency_id": "8cf65b29-c72e-440d-a6f3-bce1124e2fc9",
"db_language_id": "a846f6d1-5dae-4cb2-9cbb-94d6e36f57bd",
"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-01-24T04:50:47.3570301+00:00"
},
"modified_dateutc": "2026-01-24T04:50:47.3570301+00:00"
},
"marketing_segment_id": "aecc60d8-9438-4a7d-88eb-943a55ce5834",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "541bfc23-dbd3-4a50-915e-4caad5de200b",
"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": "df41af87-db3e-4fdc-b427-9cd37ed09a06",
"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": "35c18fd0-fd6c-44be-abad-e97c94d1f375",
"db_country_code": "sample string 28",
"feelist_id": "7a9ca589-efc2-472b-ae64-ecad926206b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8f47b69f-470d-41df-a03c-5a03ab7053e6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2983b4a3-fa48-4e5e-a1b1-16e85fc3ab73",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-24T04:50:47.3570301+00:00",
"db_currency_id": "1119a9ea-26f5-4ddc-9eb3-7da5e7bbe78e",
"db_currency_code": "sample string 10"
},
"company_type_id": "8b41abdc-f2ad-41e5-8e66-840a22bcd676",
"company_type_name": "sample string 32",
"company_type": {
"id": "09daea56-f7d9-4352-8b71-1f344498775a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "293c1e26-4111-4213-9201-0854219eacd3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c338a5f2-c775-461f-80d6-db1a1d9a5190",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "467f8e79-89c7-4606-aa59-f4035d9a1a2e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "87ae973c-e791-478d-8d36-b65ec14099f2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b288621a-507b-4bd1-b38e-225b7a69cf79",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-24T04:50:47.3570301+00:00"
},
"company_sector_id": "944202ba-e4bc-488d-8818-e275ce85315e",
"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": "d4cc7a6b-bf91-47a8-a0c9-0ea477c024de",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d6993840-7f91-4920-bd2f-dd31db12a730",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "602af1f2-25f9-4d0f-bfb8-a34f434ec222",
"account_manager_user_code": "sample string 56",
"company_status_id": "22dfad7a-1ac6-47d5-bad4-65f2e4152d8d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-24T04:50:47.3570301+00:00",
"id2": 60
},
"db_language_id": "acc0496d-a883-467a-a626-5a65180be01f",
"db_language_code": "sample string 7",
"db_title_id": "38cd5626-ce2a-480d-8606-5369a3c41d52",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-24T04:50:47.3570301+00:00",
"create_date": "2026-01-24T04:50:47.3570301+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-01-24T04:50:47.3570301+00:00"
}