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": "6dd58e2e-3aa7-4513-8160-3b78c089fa7c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4fe74e45-0964-4204-89cf-22f6a9180ce8",
"company_code": "sample string 5",
"company": {
"id": "fc4a9cb7-1803-4a20-9dd6-8b32618e43d4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-02T13:21:20.9493897+00:00",
"sales_territory_id": "6784a24b-b310-4c8a-9abb-5ca16d4716f2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "168194bf-87ac-40b6-9594-82951a1ae995",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0c791ea3-e1ae-47ed-9e3e-0a09d378735d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0a22f5af-1398-4d76-a55c-b67ca315ab23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6c844906-b372-4354-90d4-2c3bfa641bbc",
"db_currency_id": "1224a70d-09a6-4c25-a9bd-1a060ced27b3",
"db_language_id": "7f69d362-9177-4197-8e03-5c56aaa451da",
"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-07-02T13:21:20.9493897+00:00"
},
"modified_dateutc": "2026-07-02T13:21:20.9493897+00:00"
},
"marketing_segment_id": "db82ce75-f699-4668-b669-28e88630a4c9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c1f2fa72-ea7b-4f93-9835-73b1557501e4",
"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": "4ab7de81-b7a9-48a3-9b28-2db310a2e449",
"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": "093df8af-5b5e-4683-b08c-b55b8e149454",
"db_country_code": "sample string 28",
"feelist_id": "2922423e-2dd7-44aa-a7cd-899678696f84",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3809e4cf-a000-45c9-a707-73b03a5e403a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "148a7a55-67c0-4896-a685-22d2938e6377",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-02T13:21:20.9493897+00:00",
"db_currency_id": "be6b3bb9-8cb7-4ad8-8984-3d2d3dfbb745",
"db_currency_code": "sample string 10"
},
"company_type_id": "910645bd-de05-45f6-a55e-fb0367198c01",
"company_type_name": "sample string 32",
"company_type": {
"id": "52d92b8a-a4bd-4ba5-977c-321bc48efad6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5126d05-c14e-46df-b593-78e9f5977937",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3885e763-e4f1-4095-8bf1-fa8e956e7550",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7ad67c49-8893-4954-af7b-2894cc148926",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "404640ce-61ed-4757-9dd5-e174ee809f8b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "87dd84df-af5d-4d4c-b60b-33f1bbe8a83c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-02T13:21:20.9493897+00:00"
},
"company_sector_id": "e0c63831-bd42-4883-aa48-1bd43670803b",
"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": "2b28c1e7-ac9f-43dc-878f-5bee43bb04e5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4b6035c2-a9a5-4bbe-bd73-72834120bef2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0d845407-99d5-4280-94fa-214995221f30",
"account_manager_user_code": "sample string 56",
"company_status_id": "fd31ba68-db60-49d1-a6c0-b22fe0d6bc70",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-02T13:21:20.9493897+00:00",
"id2": 60
},
"db_language_id": "516699c5-0a52-4ba6-83f8-aa66a979a891",
"db_language_code": "sample string 7",
"db_title_id": "0181fdcc-d905-47a2-a5ed-58d99661bc3a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-02T13:21:20.9493897+00:00",
"create_date": "2026-07-02T13:21:20.9493897+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-07-02T13:21:20.9493897+00:00"
}