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": "84a2303d-07cb-4cb7-8609-b8100ad693ea",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5d971d84-8353-402d-9a83-d59262cd7dbd",
"company_code": "sample string 5",
"company": {
"id": "95a4d778-0324-4fa8-99ff-ba324beca3b0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-11T19:07:09.1874142+00:00",
"sales_territory_id": "bbbf5168-e526-4ef7-8288-f91b26ccce16",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "61fdfafe-65c0-448d-9082-231e4301e0a8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bfefccb3-dcda-4983-8e7d-5865a4eb947e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1b2fad0f-ba64-4594-957c-21ca3123334c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f01f21fc-2f4c-4dde-8972-a2a8a166fd9e",
"db_currency_id": "4ff1b211-1009-479c-a328-c07b67d4af00",
"db_language_id": "c2096c17-6d95-4441-9e64-8c644af4aef3",
"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-02-11T19:07:09.1874142+00:00"
},
"modified_dateutc": "2026-02-11T19:07:09.1874142+00:00"
},
"marketing_segment_id": "6b185f23-4bc7-4330-9adf-079999a76ebf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "28bad1ef-c856-4877-b204-229ee68226b2",
"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": "5d3f3b45-bc1e-429e-a07d-fe0d2e3086df",
"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": "859e3129-5e3c-4b74-b23f-0f282418f991",
"db_country_code": "sample string 28",
"feelist_id": "c351df4d-6f36-4344-a9d5-0d0d855a8c4e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5f0881e5-a2e8-455b-af51-5a6e447ac8aa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e22777a6-5199-451a-8157-71aa8380ad7e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-11T19:07:09.1874142+00:00",
"db_currency_id": "63884fc4-ce8d-423b-8797-3428cd4393fd",
"db_currency_code": "sample string 10"
},
"company_type_id": "2b07d468-bdf2-418f-9f1f-e40297214838",
"company_type_name": "sample string 32",
"company_type": {
"id": "4407926d-e3e4-4e87-a4b3-0d65d7db23bb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f5d9a806-0b59-4982-ad35-2c0054d35d44",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e7923c1f-f11e-4494-87dc-6bb78d5cf9e5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "146cdbb5-9c87-421a-96e6-c238d181af84",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2cdb05cb-1e8d-4291-83cb-fe4b5cafcc34",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "13b29710-0a6f-4714-8b83-c238ee64c2a6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-11T19:07:09.1874142+00:00"
},
"company_sector_id": "e0e95e8c-7fa1-42f5-8d30-c8c6a5a8b967",
"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": "438ba703-eaea-4f59-a238-52cca3d1638c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b323d471-296c-48df-8dd9-8e1f05a73c25",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d3d3fe86-92c7-40f6-8544-33cdd4259617",
"account_manager_user_code": "sample string 56",
"company_status_id": "c6a58a18-ea79-4424-9d26-e6d0a6ad13af",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-11T19:07:09.1874142+00:00",
"id2": 60
},
"db_language_id": "8802f6fb-5755-4358-8e3c-a70824326d0d",
"db_language_code": "sample string 7",
"db_title_id": "790f1bfa-fdd6-48c2-8423-35cef6017022",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-11T19:07:09.1874142+00:00",
"create_date": "2026-02-11T19:07:09.1874142+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-02-11T19:07:09.1874142+00:00"
}