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": "c1265c8e-682a-40e4-abdc-4c965dedb85c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4fd70059-1def-46f4-83d9-fc76bd80a06f",
"company_code": "sample string 5",
"company": {
"id": "c499bd98-527c-4d9a-933c-6dcf53f36486",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-28T15:39:58.3865835+00:00",
"sales_territory_id": "ff1df403-195c-4a38-9692-5499667b36a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "773ab008-7035-40ef-835f-035dc801942f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ba6f041c-298c-4f91-ae4e-a56dba5d1eb6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dc700ac3-bdcb-42a9-9809-04d6c11958ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6cfaefc3-3035-43b2-b148-6f182512c4bc",
"db_currency_id": "25bdec27-90ea-4254-a89d-b6e84a16becf",
"db_language_id": "ca34604f-9840-46df-b1e7-ee4a7e81dd16",
"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-28T15:39:58.39729+00:00"
},
"modified_dateutc": "2026-10-28T15:39:58.39729+00:00"
},
"marketing_segment_id": "130ab2d6-4f49-403c-a02e-686fcb54acef",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e2f1c66f-1bbe-4ef5-bba3-3d94af4fc699",
"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": "9e401b1a-e75d-4a54-a511-7884f3696854",
"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": "edfd9c0f-c60e-45c6-819e-5b4c76efe197",
"db_country_code": "sample string 28",
"feelist_id": "a4b71475-3371-45b6-a574-9ac2613fcba1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dfdf9af4-a056-4b28-a8da-40362acae04d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "36bafbfa-735d-4ba8-b1b6-5cb7779ba399",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-28T15:39:58.39729+00:00",
"db_currency_id": "5ff8073e-98fb-44c2-a5ea-eb723839f4e3",
"db_currency_code": "sample string 10"
},
"company_type_id": "8c4c0e69-d28f-4134-a153-d98b3118141e",
"company_type_name": "sample string 32",
"company_type": {
"id": "c9b565dc-73d0-4d5d-a12f-19f76100d310",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ad34de1-30d0-4dd2-ab88-b3bcf3d561f0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "25a5ed78-6183-4344-92af-d3aadb11950a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "726d7577-1c20-400f-9b3b-8eea14a7e7b5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "85797f7b-c7fc-4b81-bec3-8a5fca7abe95",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d9223517-b417-4752-8de9-b9d95c7ec894",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-28T15:39:58.39729+00:00"
},
"company_sector_id": "131244b8-30ff-4f6a-a740-3e8252ce2c07",
"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": "65b3238b-d255-46f9-9516-77fc76384bcc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d755ac06-093c-44f0-92d4-7c7164042cf2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e60c8637-67f4-497f-a443-cdeae7c2a532",
"account_manager_user_code": "sample string 56",
"company_status_id": "8a286081-fc7e-43a6-b6e1-21f021a5cef2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-28T15:39:58.39729+00:00",
"id2": 60
},
"db_language_id": "83fa6c12-85d7-4165-ac41-630a5d177f67",
"db_language_code": "sample string 7",
"db_title_id": "70c4078d-be47-44a6-8148-f6181c3f3e27",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-28T15:39:58.39729+00:00",
"create_date": "2026-10-28T15:39:58.39729+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-28T15:39:58.39729+00:00"
}