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": "25ffce7f-f023-4408-803f-1591eff8b283",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "61ed345f-2b38-4856-9f7e-a75a4ff3f7e6",
"company_code": "sample string 5",
"company": {
"id": "b3095ef5-f95d-4c17-9b5b-f5e903bc0822",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T03:11:49.5508478+00:00",
"sales_territory_id": "5619b93a-3690-4d27-bbba-3f22ff076af2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3e351706-7fc2-493c-aee7-55bcb809a8ae",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e27b5af-f6a7-48c4-b19a-d83ad8398f25",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a30954d0-58f1-4df4-b53f-0fa9bbb62345",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "100b7ca8-4c52-4bd6-a6fa-0c3ebf5a8eef",
"db_currency_id": "20db2a4a-31fa-4fa8-ae19-110edd9db733",
"db_language_id": "7f086049-582e-47f1-b393-850171fecc2c",
"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-06-02T03:11:49.5508478+00:00"
},
"modified_dateutc": "2026-06-02T03:11:49.5508478+00:00"
},
"marketing_segment_id": "67bd45a5-9743-4d1c-8608-186d00e0d877",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "319e53ba-4676-4da1-b01c-2cac8ef08906",
"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": "06b25b44-35b8-474c-99db-f334cb490f6b",
"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": "37063ec5-da72-4feb-83dd-1f3cccfa17a4",
"db_country_code": "sample string 28",
"feelist_id": "f727e0c1-c21e-4278-8401-e8de7a02997f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f95cd1e5-0478-48e9-b4cc-46a01d05f9d5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "80162030-02ae-47e4-8dab-9cc66fa23b5f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T03:11:49.5508478+00:00",
"db_currency_id": "2d3dcde7-7bd0-4dbb-a73d-5f7970b3c084",
"db_currency_code": "sample string 10"
},
"company_type_id": "8279f059-ded6-48a9-a6d4-38e33d7ca99c",
"company_type_name": "sample string 32",
"company_type": {
"id": "ec994c50-e679-4f74-a477-d6f38c488867",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a4bad13d-1dce-4be1-9747-a016b61e3087",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9d9c4cf1-5107-4e52-9274-38dd8a0aeadc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0aebebe3-942d-43ad-8229-7d19b334d8f5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6a85782b-2f44-43f6-8c8f-5d6a7c743ff8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7bb40382-d916-4dee-b0a4-1a33d888d4aa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T03:11:49.5508478+00:00"
},
"company_sector_id": "0e592450-1762-47df-b38e-d61f9d201e9a",
"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": "307f000a-6f79-425b-bbd8-1de48acbf53d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "432550eb-336c-4cdd-bc0e-6c2fdfc49436",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bc6866bb-a9e3-44aa-918d-2ef95c099f1a",
"account_manager_user_code": "sample string 56",
"company_status_id": "9555e186-d209-4edb-bd3d-26ff529a0b08",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T03:11:49.5508478+00:00",
"id2": 60
},
"db_language_id": "36080adf-6027-40d6-a9e6-fcc9110ab925",
"db_language_code": "sample string 7",
"db_title_id": "8d33a2c8-bc09-4df3-a370-5f3f2d669f67",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T03:11:49.5508478+00:00",
"create_date": "2026-06-02T03:11:49.5508478+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-06-02T03:11:49.5508478+00:00"
}