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": "988e8fb0-c693-44e0-bea4-95e2861cbf67",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6f73682c-e320-4185-8f58-cad1bf88f2cd",
"company_code": "sample string 5",
"company": {
"id": "f9760b1e-922b-4f17-93a7-f06a4475becf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-09T03:56:02.1225+00:00",
"sales_territory_id": "ce7e84bd-bcb1-4f55-9352-31dfb9f8d759",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cdb91501-e258-4fab-8290-5fd27e9c59d1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e2fd65fa-bfb0-45b2-b74a-d31b4cacca30",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8b249dc-eb4f-4a7f-a383-ce2eb534e32b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45292921-5791-42c9-8254-96ef2a632428",
"db_currency_id": "091b98a1-a50d-4ffc-9e21-85cd47799f5f",
"db_language_id": "b3316d76-fb13-4207-94a2-93d3cd2ed3f0",
"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-10-09T03:56:02.1225+00:00"
},
"modified_dateutc": "2026-10-09T03:56:02.1225+00:00"
},
"marketing_segment_id": "6450f785-f842-442b-8dc7-73c080d5ac1d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4232d87b-1b9e-4196-958e-c796f5beb40d",
"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": "e8391c99-696b-40b6-a647-f92a29a4f233",
"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": "1451aac3-9b7b-468a-a04a-213890ec197c",
"db_country_code": "sample string 28",
"feelist_id": "5e9bd893-31e8-4136-9405-27e17d70760d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "44bcf37f-e9c2-49dd-9ff9-728c4ca8e8bf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "37f70e14-e091-419b-8ef1-9e167c27be9f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-09T03:56:02.1225+00:00",
"db_currency_id": "af5e209b-3849-47d6-95a6-2d11789c8e8a",
"db_currency_code": "sample string 10"
},
"company_type_id": "15f8f4c8-9e69-43bf-babf-955112d3fb8e",
"company_type_name": "sample string 32",
"company_type": {
"id": "891ee97a-047c-4e90-9f6f-ec6733f83a3f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85ff8466-d723-4f42-99f1-9c50adf48611",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e95e18c3-ca05-4b75-b5b9-586728f7af43",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3dceb2bd-ad32-4f1a-8419-a29aa37ce5c9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0f142fe8-58b7-403d-9270-407762efaef1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ac42ec3c-af2e-46eb-ad05-55cf356c1f5b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-09T03:56:02.1405031+00:00"
},
"company_sector_id": "3189b122-1889-4c19-ace6-e5e255e90a1b",
"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": "94643158-ad65-44f7-b764-265fa75556f6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41793496-634a-4d52-b78a-dfb188b4adff",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c15254f6-0e4f-4851-bce1-5c18ebd370ba",
"account_manager_user_code": "sample string 56",
"company_status_id": "3b2c0ef6-ba41-470d-b52e-81da11fd6030",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-09T03:56:02.1405031+00:00",
"id2": 60
},
"db_language_id": "8ba09dc7-2596-438f-9891-027f2908f507",
"db_language_code": "sample string 7",
"db_title_id": "d662d709-4e2a-4f53-80b3-6a6be6529d6e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-09T03:56:02.1405031+00:00",
"create_date": "2026-10-09T03:56:02.1405031+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-10-09T03:56:02.1405031+00:00"
}