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": "0b106832-0e1c-493d-92fe-9e144c684464",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3b4b41e7-0469-4e02-867a-6e68b41908e8",
"company_code": "sample string 5",
"company": {
"id": "e0d27e02-a096-4929-8b2b-733e31e5de19",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T01:14:08.0411207+00:00",
"sales_territory_id": "619e4763-3461-4b18-bf2f-45260f89a91b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f8af84c6-7211-4da8-804c-3b6fd005e7ed",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6469ad17-c202-4c5f-9797-6074ddaa8a49",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c765c2b1-3502-4362-aea6-2cdec1383774",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "950d3e52-7f23-4ffc-b831-596ab0367b11",
"db_currency_id": "f207d7fb-0732-4469-9a82-46f518b11bcd",
"db_language_id": "3d16ba6a-c5ff-4141-b4e8-fc705d44a21c",
"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-12T01:14:08.0411207+00:00"
},
"modified_dateutc": "2026-03-12T01:14:08.0411207+00:00"
},
"marketing_segment_id": "832f0166-7694-4a9e-8b7b-ee6a36709b65",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5ea1b5c2-e724-465e-ba01-131952046125",
"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": "95963911-17ea-4583-8f11-bb8115abeb08",
"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": "f2cf6884-5330-431d-a66c-31c038d59fb6",
"db_country_code": "sample string 28",
"feelist_id": "05849f47-470b-4030-81cd-90714687a114",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7367b396-4917-46ac-b43d-45a2cfb05d5e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ee75d0f1-38dd-479b-94fd-73d7ef65674d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T01:14:08.0411207+00:00",
"db_currency_id": "48f16666-66d9-42aa-a36e-a5dafbac0210",
"db_currency_code": "sample string 10"
},
"company_type_id": "48adfac1-8156-4d09-90ca-8ab4fafa5cd6",
"company_type_name": "sample string 32",
"company_type": {
"id": "df65fbb6-0620-49fe-ac46-01b360552f7a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1c662fa5-ba9f-4136-a595-75ce2f2b9362",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d9a8a5a9-c43e-43e0-88e3-38390eab9046",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "078af401-2c12-4654-8622-36ff8955dd69",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b41ef2d9-c25e-4540-a907-0208ca4e31b0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4003c81e-aabf-4bfb-a03f-0ba5d5e9f4d1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T01:14:08.0411207+00:00"
},
"company_sector_id": "95e6ba3a-e68b-4962-8cbc-b2b15ea8c90d",
"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": "d5d3fbb3-f77a-44d5-a832-74c8a74c48a3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d20ca1b-e62c-475b-94e6-1c3537096046",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aff11a00-4e8c-4593-b896-878a10a6ff77",
"account_manager_user_code": "sample string 56",
"company_status_id": "49b7dc4d-ecd3-4984-b3a3-3176e5f03d3f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T01:14:08.0411207+00:00",
"id2": 60
},
"db_language_id": "eee1d9bd-28e7-4550-ac4a-7283472cf5a8",
"db_language_code": "sample string 7",
"db_title_id": "e42380a4-a145-40a8-90d6-6ead72100352",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T01:14:08.0411207+00:00",
"create_date": "2026-03-12T01:14:08.0411207+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-12T01:14:08.0411207+00:00"
}