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": "2868ed63-558c-4731-ad52-7d2572f1f5ce",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8ea366ed-8c3f-43bc-92a5-a1afa4dfd2e8",
"company_code": "sample string 5",
"company": {
"id": "1f384c9e-bd39-4c35-8de6-680d7d353d9a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-20T02:25:53.988667+00:00",
"sales_territory_id": "e94bb16c-3297-436f-a9ac-893d298a2d38",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ec2788c5-e3ce-41ea-9d38-05ef618278d9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc8f1b8c-3e17-455d-b5a2-0cbfc3c1ebee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d956167f-746c-4b7c-ac03-7b902840545a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7e2c6bb-2e6f-41d8-a461-0c010d31ed26",
"db_currency_id": "853970ee-7313-47ce-ac44-a1448c7ce093",
"db_language_id": "3e39fc29-3bd7-4ed8-b181-c821e8573cf7",
"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-20T02:25:53.988667+00:00"
},
"modified_dateutc": "2026-09-20T02:25:53.988667+00:00"
},
"marketing_segment_id": "608c129d-0bf5-46e7-bc2b-b5a23069083f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3bc35e64-6627-454d-b7ce-9a16c26d0fc6",
"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": "950d52fa-4bce-4264-a26c-c42074cb5809",
"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": "cf7beed4-1847-4839-98c9-a35811d123a2",
"db_country_code": "sample string 28",
"feelist_id": "fc03c4da-9944-4432-960c-09a941975424",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f082d160-ccc4-4298-a803-487f9fddaa92",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fc3f32e5-122d-4879-b889-3869710dbc73",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-20T02:25:53.988667+00:00",
"db_currency_id": "4053985b-1af1-4a6c-9fd2-27a8e0d0f00f",
"db_currency_code": "sample string 10"
},
"company_type_id": "900a454e-5077-4fbb-8c75-0e558cc09fdf",
"company_type_name": "sample string 32",
"company_type": {
"id": "7391ffda-bde5-472e-ba67-381b9fe3e409",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ff2cdb2-fefb-4466-ab1f-fc191d9e8879",
"sales_organization_code": "sample string 5"
},
"db_language_id": "43115b2d-8368-411a-8d23-9bb10c068a21",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60bdcbb6-fabd-4ec3-a39c-b0dadcd15b71",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "62bab2c8-a922-4b96-bdce-8faa17932dca",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9915dfc9-3179-442e-9492-ad9d5aae0c5f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-20T02:25:53.988667+00:00"
},
"company_sector_id": "c2abc0c0-b96b-4d5d-bb49-f49cc3c1406f",
"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": "fd09bffe-1080-4042-ad07-5da63aafdcd1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "46d444f4-a92f-4035-ba56-d409fca8de7a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e3df5155-905b-4f7b-93d1-75988a1b0a2e",
"account_manager_user_code": "sample string 56",
"company_status_id": "fe2e880d-b477-4076-94cf-b69eccac3884",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-20T02:25:53.988667+00:00",
"id2": 60
},
"db_language_id": "60c12357-7ac9-4f64-96e5-36640efaadf6",
"db_language_code": "sample string 7",
"db_title_id": "4a360d6f-53e9-43ef-babf-c476e88f48f8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-20T02:25:53.988667+00:00",
"create_date": "2026-09-20T02:25:53.988667+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-20T02:25:53.988667+00:00"
}