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": "0481931b-25a4-4274-990c-a7c7caa1c01e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0b7a2507-844c-4999-b75d-d41acdaed056",
"company_code": "sample string 5",
"company": {
"id": "fc4005c7-90a8-4b38-a192-81cc537b3516",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-26T01:45:48.534341+00:00",
"sales_territory_id": "d6fad2d1-823c-42cd-bd1a-1f4f3beb22a2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b295bf19-f3f3-4a3f-b46c-18a709e61d9e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4a688225-82a8-47f2-b8aa-3c7033988265",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "83412d92-edf9-40f8-a3c2-ef3b057e2d82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c9c91efb-1882-43c0-aa26-655f1899b47a",
"db_currency_id": "20c85517-ddd0-4b33-9194-dee4eba6b05e",
"db_language_id": "b9c3b12f-f647-4cb5-a739-0c4d8dcbc865",
"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-09-26T01:45:48.534341+00:00"
},
"modified_dateutc": "2026-09-26T01:45:48.534341+00:00"
},
"marketing_segment_id": "c9c776d4-2aa5-4101-8fef-2cf1a4365918",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eb5db47d-5648-42f1-a261-ad1127354f97",
"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": "9f6d81ee-4e03-433d-9803-b182c593f5d9",
"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": "dc029452-ce9f-4b48-b434-54b98726ddbc",
"db_country_code": "sample string 28",
"feelist_id": "e8f5c126-94c9-4b5f-92ab-39a594e29405",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "49855f3e-6043-4e53-935e-b7c1cb5c390e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "eea21abb-a805-4161-a825-db6320fb3110",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-26T01:45:48.534341+00:00",
"db_currency_id": "97b2ccfc-0c5b-43ea-a4fb-cf091f8c5eec",
"db_currency_code": "sample string 10"
},
"company_type_id": "f4774d1e-feb2-498e-8b10-f35b968e94a8",
"company_type_name": "sample string 32",
"company_type": {
"id": "5dd1cdd1-01e8-45d3-93b2-71622b818f1a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d286f2a8-67bc-4b32-8142-f7fa0353a084",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4f910159-522e-4eaa-852f-ecbfc18125f2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f733615b-972d-4c87-b539-63d3c2d5105f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b9c314a7-dc93-4e96-a786-b3c0abf3e4a6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "035df81c-4ec2-433d-8ea6-b0b7d04f1349",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-26T01:45:48.534341+00:00"
},
"company_sector_id": "d5aa5266-ce0d-4fce-9267-9a217c8e1bec",
"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": "76dfee72-5ad2-45e7-8175-22c8ed4fd85b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "36ba4f81-a383-4309-bd5d-b972dc5ddb5e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "109fe583-f2d0-4291-a6a1-8a6912049a49",
"account_manager_user_code": "sample string 56",
"company_status_id": "fea1ec61-78f9-4540-91cf-56de6858ba63",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-26T01:45:48.534341+00:00",
"id2": 60
},
"db_language_id": "09386ad8-a52b-4557-87f0-b86756fa00d1",
"db_language_code": "sample string 7",
"db_title_id": "728b95f6-20e3-422e-b68d-5b0327c2046e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-26T01:45:48.534341+00:00",
"create_date": "2026-09-26T01:45:48.534341+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-09-26T01:45:48.534341+00:00"
}