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": "3cf24a74-7fe5-4583-b960-2a5bd6d7cd33",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7abb0811-7c24-47a1-a42c-75d7f35e031f",
"company_code": "sample string 5",
"company": {
"id": "bf560253-28e1-4ebd-b819-3dffcf07e88f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T06:13:38.3597737+00:00",
"sales_territory_id": "ec3a012e-8cf4-4ca2-a2d6-dea881a84cf9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5fe4d020-c7b3-444e-bdf1-81b7742fbec3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9cd8ef3-f36f-4b47-b927-d90c537c7421",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "070e0414-7c98-4a8d-876a-d3556389491e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f929ed-b228-4390-a9ec-7679e6eeda3a",
"db_currency_id": "9d17020c-a9bf-4131-ac1c-cbdd9abf30ef",
"db_language_id": "cd5f8cd0-e9bb-4359-9078-d9c1edba8c83",
"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-03-12T06:13:38.3597737+00:00"
},
"modified_dateutc": "2026-03-12T06:13:38.3597737+00:00"
},
"marketing_segment_id": "5cb2c277-4dfa-4025-a0e6-95da0305c0f9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ed558b1e-af30-4047-90c7-c23b334072f8",
"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": "d303c6b8-37db-4156-bcb5-060df4677acd",
"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": "3bd0503e-afe2-48ec-9152-24b09ad7d456",
"db_country_code": "sample string 28",
"feelist_id": "854123cb-c2ad-4654-b08d-07c2c423adc6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7579ed0f-f4a4-4bf3-b00e-f94de0db1c03",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "991ccca8-b5ad-4f5f-8edb-ea3730b21ced",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T06:13:38.3597737+00:00",
"db_currency_id": "51b3ffb3-d32c-4715-a46f-8cf32e7a7cf0",
"db_currency_code": "sample string 10"
},
"company_type_id": "6467f4cb-671e-43a7-9356-d6bb7170bdd1",
"company_type_name": "sample string 32",
"company_type": {
"id": "f225fa37-5539-46e9-9014-316a7f7f5d75",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eaa225cd-4923-4407-93e4-17d72af59556",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5b8fc5c5-d6a3-4096-b0bc-8cb8d1f0a02a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bdb95f38-e1a6-4ad5-816a-66afceca9906",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f56d68a2-83f6-4a39-90c4-864a379b7a40",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "298bd422-2179-4f23-9a71-f0e36e5166f0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T06:13:38.3597737+00:00"
},
"company_sector_id": "8cd95449-1a38-46a6-9b93-6fc6b3a57a72",
"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": "1918bd06-9674-4159-8d82-eb927c96d386",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "85999a9a-9561-49a9-a8b0-60c69cc1e741",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "705c6643-8cf4-4d02-9571-c41fdf629865",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ff00232-a932-484d-a58c-8ace4cd59791",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T06:13:38.3597737+00:00",
"id2": 60
},
"db_language_id": "a4b44b16-8af9-45dd-91f2-a52270a67abb",
"db_language_code": "sample string 7",
"db_title_id": "f27260d4-8d14-4572-9a51-d340bdbadc86",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T06:13:38.3597737+00:00",
"create_date": "2026-03-12T06:13:38.3597737+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-03-12T06:13:38.3597737+00:00"
}