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": "0fec7fe8-5aaa-4c89-a342-aa264a0964c5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1b92b9d0-89f1-4ec8-afad-19f9fd7aa546",
"company_code": "sample string 5",
"company": {
"id": "4ec45b63-3493-4658-8036-51fe3333aee8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-02T21:42:40.3530955+00:00",
"sales_territory_id": "7a099525-8be2-4cc1-8488-3ba049102d5a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6627f0d8-9669-4df9-a670-058e0d71a3a7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2b907d11-180d-42d3-bd72-27e9ffd496b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f7bf0c2-6b63-4867-b578-58d5a8aea4f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6dee331-ec3a-43cb-88ca-53874aee47b8",
"db_currency_id": "99ac9c0c-2da7-4f6c-8de0-9a5443aadf80",
"db_language_id": "cee8d41d-34a1-400c-8481-a61ad49aa41b",
"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-07-02T21:42:40.3530955+00:00"
},
"modified_dateutc": "2026-07-02T21:42:40.3530955+00:00"
},
"marketing_segment_id": "44de49d7-371d-4528-88bc-ff80e5300151",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "003c1bc3-2d53-4c02-95ff-e644c59aaf21",
"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": "9572736e-3017-4842-b527-29a53678099b",
"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": "7bd68d83-5e83-46fe-a8c9-9554f8b40b68",
"db_country_code": "sample string 28",
"feelist_id": "b378c6bb-82c5-4927-8031-7b6315629fdc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d19c178e-f2a9-439c-96c9-b595672e554f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c7ddb3e6-020e-4047-86b7-2a53e752da3b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-02T21:42:40.3530955+00:00",
"db_currency_id": "c5029919-d0dc-41e7-b6f8-1c4d51e5dc92",
"db_currency_code": "sample string 10"
},
"company_type_id": "2cf778e1-4ad1-47af-be39-95b2a858506d",
"company_type_name": "sample string 32",
"company_type": {
"id": "d931fded-cf38-413c-b244-8ff68cefc5bc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8e0a0416-90ad-44e8-946e-2341afaca1f0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "35a38675-9a0c-4fd6-9ece-288b3a6e7e82",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "87f7c9ca-0f21-4c72-9ac6-92c6cafd301b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3f23ce67-eb82-4779-85e7-96018b36376a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a0867c2-ca1f-4595-90a9-bc531f0e21db",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-02T21:42:40.3530955+00:00"
},
"company_sector_id": "c97866a7-69db-46bf-97ba-8d5cc36d0e1c",
"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": "7ddbb62e-2d8c-4919-9b99-4fea8b06fe31",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "22d111f5-8cbe-45df-a1dc-d6658e2f55f3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "48c078f2-f1ae-4878-956b-4cd620a25c5e",
"account_manager_user_code": "sample string 56",
"company_status_id": "fc4ffe06-05ed-47aa-a2fa-1f937065b546",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-02T21:42:40.3530955+00:00",
"id2": 60
},
"db_language_id": "6cef22c2-9d7f-4be2-ae65-bab14b5d90b9",
"db_language_code": "sample string 7",
"db_title_id": "6f1c8514-7d6d-42c3-9303-b82b4e64f8b0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-02T21:42:40.3530955+00:00",
"create_date": "2026-07-02T21:42:40.3530955+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-07-02T21:42:40.3530955+00:00"
}