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": "ee7dc9c6-6cca-49dc-bf81-5ad8a03eb2b3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0f093a92-387c-48e9-b954-2e9f40541589",
"company_code": "sample string 5",
"company": {
"id": "652bfe22-6290-4233-8b40-160dd14fffd8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-08T04:08:21.8851851+00:00",
"sales_territory_id": "29a4a4df-4e67-47e3-8ee8-8e1b7d50b73b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "22bc9384-0f58-49bd-b14b-ff1066a29461",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b5d4b83-5e30-42bf-a12a-42b572576bee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8a7aca0-393b-4eca-a74c-0607e0c03594",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dea02234-1e12-425c-900d-a50d409c4879",
"db_currency_id": "4aa3e829-032b-437a-b2cb-4550bf8baab2",
"db_language_id": "fb2188a7-33fe-4810-913d-bcc57798d1dd",
"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": "2025-05-08T04:08:21.8851851+00:00"
},
"modified_dateutc": "2025-05-08T04:08:21.8851851+00:00"
},
"marketing_segment_id": "a373df53-8886-4b72-8c5b-0a855f5d9440",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e2e35350-21d1-4235-8875-ef4da73b8f70",
"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": "38eb2522-fad7-4956-9e50-aab97a595331",
"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": "38d82ea2-e687-4c3c-b533-b0379b369d3d",
"db_country_code": "sample string 28",
"feelist_id": "d14d82dc-c177-4dc8-93ad-0daba229bd01",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d606b952-fc76-44af-bf12-c8e503ba92a6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0096a08e-b671-44a1-a138-5b3375bb838e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-08T04:08:21.8851851+00:00",
"db_currency_id": "8cd293b6-680c-4560-b940-d0c7fa4f0df8",
"db_currency_code": "sample string 10"
},
"company_type_id": "c77b346d-560a-444b-842b-434027408655",
"company_type_name": "sample string 32",
"company_type": {
"id": "af5ff14f-9ef0-44d8-a77d-edcd00865c2b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9cf48cc4-6981-4eba-a91e-a9c2dc1f1979",
"sales_organization_code": "sample string 5"
},
"db_language_id": "92f7c580-346b-4873-9eb7-22587ab52d01",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "09644f14-dd69-4a24-9ed5-1fe26f05e2ff",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4f1fcfd7-5c25-41ce-a140-febd58c7857d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "73d3b4ba-63e8-4a86-ad6d-58067263c6ef",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-08T04:08:21.8851851+00:00"
},
"company_sector_id": "3c79f4c2-2bd9-40d5-8d7e-e2a76878fad7",
"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": "b575742c-17ba-44de-a1f1-13fd21b2fb35",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3796e061-dad5-4f90-9ea8-092532c63a89",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bf917e5d-f540-496d-a4b8-f9df54cb18e8",
"account_manager_user_code": "sample string 56",
"company_status_id": "36e52aef-b1d4-4353-9d8d-89baae24d2fe",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-08T04:08:21.8851851+00:00",
"id2": 60
},
"db_language_id": "ac9bc31a-8821-4344-9e01-13b3ce7d7426",
"db_language_code": "sample string 7",
"db_title_id": "13472157-4bea-4ec8-ba25-4252325938b0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-08T04:08:21.8851851+00:00",
"create_date": "2025-05-08T04:08:21.8851851+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": "2025-05-08T04:08:21.8851851+00:00"
}