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": "b95e3e80-12e5-442d-a840-0480f26d22ee",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cae30bb2-3a59-4789-9cfe-bfc21a0d56f0",
"company_code": "sample string 5",
"company": {
"id": "2a92cca5-4971-4647-bce7-c9edd7f9e6e6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-11T07:55:37.5531446+00:00",
"sales_territory_id": "cef3be54-08f5-4c41-8ff3-4d5511d8e94e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1da98d00-c3d0-4913-ae21-5fe8c4a30cf2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "235bf156-a439-4ff9-a261-2eb7b3386a64",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1b5238aa-44a7-4a17-8ff8-48bfab938441",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "612a48ca-8341-48ae-b255-0b580e758389",
"db_currency_id": "b2bd6a96-7333-4710-a740-cf1f6b58fba5",
"db_language_id": "078beb25-06d2-4b11-9d90-6c6413ed0bb9",
"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-06-11T07:55:37.5687674+00:00"
},
"modified_dateutc": "2026-06-11T07:55:37.5687674+00:00"
},
"marketing_segment_id": "6bc03c09-0ef8-4d23-9cb1-73440cc902b5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fdc39f98-cc86-4ba6-a186-06218c262c96",
"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": "775438df-0ac3-459c-a1ac-44f2e393139b",
"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": "2655e85f-7801-49af-8b8b-2614c46b8cc6",
"db_country_code": "sample string 28",
"feelist_id": "d6a1bc7c-f9fc-46d7-85a4-13dd6f114aac",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "86f682fb-f01d-4a33-a1ab-c1958b7eec62",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "36fa3c4c-a61c-4a20-b908-5875653fc5d0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-11T07:55:37.5687674+00:00",
"db_currency_id": "1b842c6f-2e73-45e5-957e-d79f7785f27f",
"db_currency_code": "sample string 10"
},
"company_type_id": "11bc556d-e025-4fa6-acf8-803b9fc16a56",
"company_type_name": "sample string 32",
"company_type": {
"id": "f67c59ea-227d-4031-8d19-c4782a80f1df",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5cc4ded2-a5c0-4fdf-a663-04c09b2284ae",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af9cb28e-0f55-4b2d-8a37-39160581864f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c3dd432d-2b65-41ed-8384-92d28e1e41fb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a2265366-2b80-4a74-aa12-2fb5dea4a70c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "96cdfab2-95eb-45da-840e-40e1856b4166",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-11T07:55:37.5687674+00:00"
},
"company_sector_id": "216c3f9c-ff42-48b4-b807-7f8e6b7bacbf",
"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": "1fe26aa4-42aa-4680-8be9-48ada8057281",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8eaf0f31-8bb2-486c-a7dc-f27c35bfaf79",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5ba58c18-90c6-4045-8712-19de487ca017",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ea6d013-487c-4c49-b763-dffb91c31498",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-11T07:55:37.5687674+00:00",
"id2": 60
},
"db_language_id": "08b2a5a7-b0c7-4e15-985f-687ae90492e2",
"db_language_code": "sample string 7",
"db_title_id": "3da45389-77af-446c-ac0b-4f612c5daf05",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-11T07:55:37.5687674+00:00",
"create_date": "2026-06-11T07:55:37.5687674+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-06-11T07:55:37.5687674+00:00"
}