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": "e6c51c5d-76fc-4311-b90d-be48645da6b6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "84acf5df-f81a-4814-b2fe-ae7dfca3581a",
"company_code": "sample string 5",
"company": {
"id": "12c3e7e7-0677-44ad-8700-689015e7b9ca",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-14T00:48:20.5504451+00:00",
"sales_territory_id": "a89e9937-77b1-497a-b900-369734872f18",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "756b32ac-b3cd-45c7-b47a-96e7462ce951",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b23a2685-62fc-43ff-beb8-471c3e35a689",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a7bcc38-7278-404f-8769-5eaf95c27964",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "396ee89f-e351-4343-950b-5f9ec21e4dba",
"db_currency_id": "888a9508-23e4-43a1-b36e-4eb4d187a3de",
"db_language_id": "234c4f8c-4685-4ffa-b701-c48cc881246c",
"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-14T00:48:20.5504451+00:00"
},
"modified_dateutc": "2026-03-14T00:48:20.5504451+00:00"
},
"marketing_segment_id": "bf09080c-389f-4a90-ab88-99884870a440",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cfac29ad-6ded-4b1c-a5bd-8aac2e6ba2ae",
"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": "295ed20c-002e-4b22-afad-fff655198f6d",
"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": "eeeec43e-fa5f-4b1a-a387-01834f969441",
"db_country_code": "sample string 28",
"feelist_id": "abc5f09b-00ff-424f-92d0-3e4eacb74f61",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f850d77d-e727-416b-9478-80b7fd8b6b85",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "057159c1-53a0-4de8-8419-912d1890e201",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-14T00:48:20.5504451+00:00",
"db_currency_id": "c0174963-4e99-459a-9193-91271592cf55",
"db_currency_code": "sample string 10"
},
"company_type_id": "12e9c286-1d49-4aaf-b642-ec9fcae25d53",
"company_type_name": "sample string 32",
"company_type": {
"id": "6d739f6f-d05a-417e-ae20-609ca0253201",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cedf7bf9-2dc3-4417-9ce0-2f593d4e4221",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3beb7b69-4dc8-4652-b96d-5ad740cb3f9b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "da64b29b-8496-4ad8-83b1-2b0e97c27d4c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "53e21362-8c61-4b5a-9f5c-cbc83da5c4fb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9b02ff2d-52de-4889-b288-a15a9e917d78",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-14T00:48:20.5504451+00:00"
},
"company_sector_id": "12ad474d-09b5-49f5-9165-b06041cf49c3",
"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": "cc18cbd1-4e8c-4470-9f0d-8b5018a421c4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "45b4ec95-4c71-47d0-adcc-5b9d2e382f04",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8ebc144b-acef-4a8a-969d-067b480e1a7a",
"account_manager_user_code": "sample string 56",
"company_status_id": "7c66568f-b994-4f5a-a617-53a488adbd68",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-14T00:48:20.5504451+00:00",
"id2": 60
},
"db_language_id": "9a66d488-2794-4c51-9a4e-3bc7f4abd635",
"db_language_code": "sample string 7",
"db_title_id": "f3b7786f-bc3d-41d7-b186-aa5a321cc1a5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-14T00:48:20.5504451+00:00",
"create_date": "2026-03-14T00:48:20.5504451+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-14T00:48:20.5504451+00:00"
}