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": "e6bd4c9d-e119-4e19-916c-7bcbaa21bb33",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "92ffdd31-e22a-481e-bca9-b6bdf88f3478",
"company_code": "sample string 5",
"company": {
"id": "5e97459c-cc33-4250-9cf4-2b614e217b2b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-08T12:04:23.3242981+00:00",
"sales_territory_id": "fc5aecc5-a024-4cf5-8457-31bde752f62b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8c9710aa-4204-4d54-aaa3-fab8074f6904",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db9d3e17-2bc3-4bbe-b789-c86963fce82a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5efd65d9-5948-47a2-a6a6-50419ecc36ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cea6eb86-0d1b-4a79-b45f-6afb8ef55598",
"db_currency_id": "d812ae83-71b0-4229-a523-defa03028094",
"db_language_id": "3dadc4cc-74cb-4269-8a58-48922d6016dc",
"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-08-08T12:04:23.3242981+00:00"
},
"modified_dateutc": "2026-08-08T12:04:23.3242981+00:00"
},
"marketing_segment_id": "681e7594-9cb3-45ac-a173-141dc5ad085d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9f15c76f-ac8b-4422-8dde-827d653990d4",
"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": "d9da3050-9493-4173-9d92-a0c036b00eb8",
"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": "2cf53f6d-8288-454f-8789-cb089e11f28a",
"db_country_code": "sample string 28",
"feelist_id": "de49e162-936a-43f7-b366-d5bd2f08ac8f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "55131fd2-cfee-4bf5-ac59-b48baeb9e82c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fa1d1673-b6d9-4e7d-b0e2-f25569a7a4db",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-08T12:04:23.3242981+00:00",
"db_currency_id": "af581900-f2b6-4140-aa64-fe195ccaf8d5",
"db_currency_code": "sample string 10"
},
"company_type_id": "cac47add-ce05-4232-a4e1-0129cfd38f30",
"company_type_name": "sample string 32",
"company_type": {
"id": "73e3bd07-f792-42f2-ba86-d7caf3aa1d26",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "38dbf570-99b9-4535-bf8e-b6b89b68cc4c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "69485461-6ae6-4da1-a49e-817d1b34c262",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6a7d0ade-bdd3-4b69-9717-62a6d9559fe7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dfa4b653-cf42-4eb3-a6e3-107450842efd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "491a597f-c6a0-4cff-a006-451286a99b25",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-08T12:04:23.3242981+00:00"
},
"company_sector_id": "2a2d4d62-2e58-4bb6-9f64-a5ed8369aa66",
"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": "ede0ef37-7443-47bd-ae40-43beac83fdd3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d007945e-15de-4ef5-bfd1-149e5413e5cf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "50cfb0e4-146f-4f54-8f17-41fbdbe42212",
"account_manager_user_code": "sample string 56",
"company_status_id": "ac70e72c-7929-403f-a4ec-ab3c1a2f1941",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-08T12:04:23.3242981+00:00",
"id2": 60
},
"db_language_id": "e4bb48ff-6e23-4901-a0cb-9b35207594d0",
"db_language_code": "sample string 7",
"db_title_id": "3782cac6-c0af-4a84-bb45-4d488e4cb902",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-08T12:04:23.3242981+00:00",
"create_date": "2026-08-08T12:04:23.3242981+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-08-08T12:04:23.3242981+00:00"
}