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": "c7c2b8cf-0f53-4da1-9488-95c4178af83e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6c3907be-72f7-4a6e-9a64-1217abe387c4",
"company_code": "sample string 5",
"company": {
"id": "00823b89-eddc-4430-bf17-c526090b1bb1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-18T03:36:48.9225164+00:00",
"sales_territory_id": "5beebce6-34bc-41f7-a85c-e101849f4ca6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d9e97e09-5c1f-479f-86c2-b5975985fdbb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1c36ca7b-a081-4efa-bd76-463a7fb815a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d6e409b-7035-46d4-90c1-c768e8cfb2c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bd16b7b-b6a8-4fcf-acb1-45a2ca05ab62",
"db_currency_id": "9bebe748-d489-4d01-9a20-ea090d70bf3c",
"db_language_id": "6a4aa457-a721-4855-b723-617d64e3000e",
"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-18T03:36:48.9381376+00:00"
},
"modified_dateutc": "2026-07-18T03:36:48.9381376+00:00"
},
"marketing_segment_id": "175e9c32-316d-4ad6-95cc-46771a9e82f9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e734e694-8f30-4146-a3f3-16b3aea558ad",
"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": "2d4e4810-2d98-40d3-8a48-88675ab29cf0",
"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": "2ba17dea-101d-4233-9d5b-47b7c9e7ed49",
"db_country_code": "sample string 28",
"feelist_id": "0cfd8e36-a7a5-46d5-89e5-3f2bac32369d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "920d457b-80ce-4093-9756-17e53b078e92",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b6866624-c802-49de-bc79-fa2ebaa7dfde",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-18T03:36:48.9381376+00:00",
"db_currency_id": "808fc262-38a7-4062-bb9a-8614e4fb572d",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf78750d-e431-4f3c-8dd8-52221e9af50c",
"company_type_name": "sample string 32",
"company_type": {
"id": "d28a9688-8798-4711-b209-8f6ff86bc885",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "40970745-86d7-410a-a643-2f4790fdcffc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3f355b43-0cdc-44c9-a602-ecff70b15385",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5563b468-59ff-476d-a32b-c74067809d66",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c90e030b-81f8-405a-b811-8f9e102d4f0d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0264380c-ec78-4836-b912-ff5e6c06bc56",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-18T03:36:48.9381376+00:00"
},
"company_sector_id": "cbe6913b-9398-4a1e-9d36-cd54586418a4",
"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": "6293c96d-42c8-4be9-986a-e811d03fd586",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ba74ec76-2aa2-43fb-b24f-a7d3a0bc520a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "13e1de91-f548-4955-be51-5f7cbb722f05",
"account_manager_user_code": "sample string 56",
"company_status_id": "66e4a48a-f7e9-445f-a013-dad3ac8d825a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-18T03:36:48.9381376+00:00",
"id2": 60
},
"db_language_id": "51187cb2-de9e-4aa6-b62f-13abdd9a7a4a",
"db_language_code": "sample string 7",
"db_title_id": "3b76df98-8bc1-4526-8c8f-98b935cbabc1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-18T03:36:48.9381376+00:00",
"create_date": "2026-07-18T03:36:48.9381376+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-18T03:36:48.9381376+00:00"
}