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": "80fafccd-28bd-427b-8dfe-06ef62eda9af",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "02e2a7e9-317c-407a-9727-bddc3ca348ff",
"company_code": "sample string 5",
"company": {
"id": "0793b6b3-3054-4f30-9228-d7722384b6ba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-02T16:13:32.2820683+00:00",
"sales_territory_id": "b4275541-b10f-4bc1-83dc-d152c9f1561c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8ff643fd-192c-44f9-987a-e65fafd0c434",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d758d31-43b7-4e9c-b43a-2eec134a5241",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1b16f16d-6406-421d-ac7b-4ec74c92c390",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd9e3385-df66-4098-b436-4cca6745fa8e",
"db_currency_id": "a512dda3-090f-4809-98b0-ad4867d40fb8",
"db_language_id": "48365e2b-6100-4274-93cd-e5a29daff819",
"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-02T16:13:32.2820683+00:00"
},
"modified_dateutc": "2026-04-02T16:13:32.2820683+00:00"
},
"marketing_segment_id": "ebf74fdb-ebc4-468d-b2e4-408d2f9eba27",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "83090341-a2fd-478d-9f74-1b11d7b15b1b",
"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": "7846b467-4621-4268-8934-bdc412e71639",
"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": "6b6593d0-19ae-499e-80f3-0ab9d109f375",
"db_country_code": "sample string 28",
"feelist_id": "8cc273d2-c3ad-4664-a203-96fbf19db659",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e6493ead-5de4-4bd4-bb89-b36c010adfcd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "398c19ed-24ff-46e7-9e29-9d1f0845fb87",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-02T16:13:32.2820683+00:00",
"db_currency_id": "dc2e07c0-e1bf-4813-af1f-a95bfe633d7f",
"db_currency_code": "sample string 10"
},
"company_type_id": "c59c8a00-fae7-4a68-9316-c209864ece63",
"company_type_name": "sample string 32",
"company_type": {
"id": "538a4c04-383e-421f-96a6-74dab79f2cd3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c541d04e-6c43-40b1-89c8-e6685a6ffba4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d68d2924-320a-4b12-9aae-f7a9245abc7e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6d5b328f-5332-48ee-b5ed-1734635f1ee5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "26117906-0bb7-47ab-bf96-c183a6c18443",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8540e6f1-dc95-4423-aefc-7f46e89dc18a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-02T16:13:32.2820683+00:00"
},
"company_sector_id": "2d7b35c1-7f79-4429-8126-27d42469a011",
"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": "8b0499fe-6149-452a-9af5-95960a63f82c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eea822c8-4237-47da-b38c-a68c02f01ba0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "528018c1-0bcd-45fb-aa63-357abd7cb88f",
"account_manager_user_code": "sample string 56",
"company_status_id": "09f19976-9a81-436f-8649-69ca2f42e096",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-02T16:13:32.2820683+00:00",
"id2": 60
},
"db_language_id": "8401f36a-8d6a-4528-ac7a-ecf4d19e804a",
"db_language_code": "sample string 7",
"db_title_id": "1f6a11ef-e7a5-49ee-b643-cf0be74e3d53",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-02T16:13:32.2820683+00:00",
"create_date": "2026-04-02T16:13:32.2820683+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-02T16:13:32.2820683+00:00"
}