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": "7fd4ef16-4ba0-4d94-b843-8a59caa1c4c6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5e04f12c-cb6d-4c44-82f3-3e1a49347912",
"company_code": "sample string 5",
"company": {
"id": "348c0107-f40a-4f54-9331-2289fa30b6a1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-27T03:25:35.7186884+00:00",
"sales_territory_id": "2963a65d-0891-4694-9c41-770147692b08",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5de0cfc3-251a-44a0-8478-0430821a68c8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f27fd391-f8ac-4ee2-ae8e-65b2f9685408",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f3fbe3af-28ef-453f-9182-695cdf8f738d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a23faf8-5ed3-4162-a979-3ec73d057672",
"db_currency_id": "a6b4c8fc-d23a-477f-9fc1-dad3bc24ef07",
"db_language_id": "c6216456-34cf-4d59-b187-6ca35c51a362",
"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-27T03:25:35.7186884+00:00"
},
"modified_dateutc": "2026-06-27T03:25:35.7186884+00:00"
},
"marketing_segment_id": "1d501905-8f75-453d-ab83-18e76a71e5fe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "125ca844-f524-4964-8e5e-ea70169523de",
"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": "ae4fb6fb-7c6c-44f5-8566-2cb162ace749",
"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": "2f034628-5fe9-46a5-8b54-ded85cd6c6f4",
"db_country_code": "sample string 28",
"feelist_id": "f749e135-b0e9-487d-b79e-cb92b8df92d7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a4c5bce2-3f1f-4481-83a9-42f558f6e526",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "360e645e-350d-4baf-9947-ac0f6cd2f285",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-27T03:25:35.7186884+00:00",
"db_currency_id": "63a8d598-be1a-49b4-a1c8-5ce9e394d3b5",
"db_currency_code": "sample string 10"
},
"company_type_id": "f257cfd9-ac5c-47a7-9078-3d77bd7248f9",
"company_type_name": "sample string 32",
"company_type": {
"id": "29c4acb8-b6e9-409e-b1ee-5d15e3fca5ac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "45b8b6a3-4bb1-4c53-b41b-1d67e976145a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "29a4fdc4-a9bd-4bc9-818a-e6cea7eb61d9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "30f98c54-1b73-4c16-83c5-e6cc9e374d5f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6ee1e3ff-7327-472d-8e9e-6f26b7a69ded",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0ea29727-de0a-4c87-a1e3-69cea58668f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-27T03:25:35.7186884+00:00"
},
"company_sector_id": "65a38eed-cf3b-4293-8193-5c34d945f079",
"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": "c3df2c08-66a9-436b-b1b0-b125717ca9e8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eecef52f-8a51-4b87-ab1b-1efcf2ee2035",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c6cc7997-d2a4-4844-8521-c99b126486c1",
"account_manager_user_code": "sample string 56",
"company_status_id": "3bf82a3e-2aec-4f6c-844d-0580f39bd027",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-27T03:25:35.7186884+00:00",
"id2": 60
},
"db_language_id": "d3b0710f-1d94-470c-9033-933b844b3698",
"db_language_code": "sample string 7",
"db_title_id": "c5c90b31-b6bf-434b-be90-85b99acc859e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-27T03:25:35.7186884+00:00",
"create_date": "2026-06-27T03:25:35.7186884+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-27T03:25:35.7186884+00:00"
}