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": "ddfa323b-0951-4fe5-97f0-1d2a34e2d66b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2f02bd0f-b86b-426c-845a-7bf801c68b06",
"company_code": "sample string 5",
"company": {
"id": "1b8adb43-37b7-47ab-90d1-42503d0ef7b2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-25T00:21:47.7015211+00:00",
"sales_territory_id": "af8049e6-7d9d-4098-8557-6da0bd0d05e1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5408ab51-3b3a-4988-b2af-85e784a9ce96",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "599218f3-a6ad-4cf1-a122-02467562163a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "66cfe480-d3ea-459b-9311-d82ce462b978",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4316992-bc87-4fea-a3b4-54c8d71ba224",
"db_currency_id": "80dbbf1b-23bd-41e4-bcc4-4149110cb51c",
"db_language_id": "8d80e107-33b3-4ddb-81c3-ef09af127a6a",
"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-25T00:21:47.717174+00:00"
},
"modified_dateutc": "2026-01-25T00:21:47.717174+00:00"
},
"marketing_segment_id": "fd17d74e-876f-4344-9e0e-12aacf158871",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8feb9a2e-4bcc-46b8-97fb-6c05ebc63960",
"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": "7962b4f2-5539-43fd-9e33-27f671846fa9",
"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": "11803abc-d9ba-49af-a2a0-4c321116686e",
"db_country_code": "sample string 28",
"feelist_id": "332aa1dd-8fb3-457c-b1a0-1cd2f9eeeb24",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8ff1f010-d357-44dd-848e-b611e83cb87e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f7e12c39-8248-437b-a2d6-4853000e4418",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-25T00:21:47.717174+00:00",
"db_currency_id": "e737bf89-3808-40f3-b855-ead6ec8dc8f1",
"db_currency_code": "sample string 10"
},
"company_type_id": "54ffdf0a-e5f9-46d2-a1eb-0a1c21591aa3",
"company_type_name": "sample string 32",
"company_type": {
"id": "56b88e5d-9511-4d93-9993-df3148a8f187",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "02bdd35e-ea16-4f0d-9960-8aed01d33fb3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ac33b775-c6f1-4637-bbff-0d2ac6cd4739",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c19199c8-f975-4467-92d5-fab3b9709481",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ecb99f79-c763-49ea-9ffb-3d70d9e01867",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "15b69e96-8c27-40ae-a02a-4d1632c2623f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-25T00:21:47.717174+00:00"
},
"company_sector_id": "d1565de5-1f38-46bc-adb3-036812775bd6",
"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": "a659cbcd-f8d7-46bd-9f1e-663e1c3a9f9b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d5641969-f649-44ba-8003-18928d0df8b7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f73c82de-5162-483d-ac00-7ca6c01eb495",
"account_manager_user_code": "sample string 56",
"company_status_id": "c0938434-f63d-49d1-96e1-a2448d349b1a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-25T00:21:47.717174+00:00",
"id2": 60
},
"db_language_id": "4746f640-0ffc-433e-8899-0a9945c50386",
"db_language_code": "sample string 7",
"db_title_id": "e55fd95e-d7aa-4996-96c5-bb5442b73eac",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-25T00:21:47.717174+00:00",
"create_date": "2026-01-25T00:21:47.717174+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-25T00:21:47.717174+00:00"
}