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": "497ac929-6724-40f2-9109-ba4ace5c9506",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b44d38e4-835c-4066-9e0d-961c0dbcfdd9",
"company_code": "sample string 5",
"company": {
"id": "6bd72ba6-5e08-4ace-8879-e9bee7252a00",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-30T11:26:28.1144408+00:00",
"sales_territory_id": "f9fcba88-a855-43fb-9f2c-522253dcdbfb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "58ddac51-7e6e-4525-9325-0e07f82eaa59",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88353bdf-b122-44e0-b2de-5f0a619ca29d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98fca56b-a628-4ad6-9402-61ddddfcf942",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f77a418f-c7ac-43e2-9b30-c00b3263b372",
"db_currency_id": "4440d6fa-d502-40c7-8107-310ab8ae15be",
"db_language_id": "d8b251cd-5a93-4e32-a761-30259cae6daa",
"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-01-30T11:26:28.1295576+00:00"
},
"modified_dateutc": "2026-01-30T11:26:28.1295576+00:00"
},
"marketing_segment_id": "ff62ac72-9fd9-465d-ae60-716aae385aa0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "142c9671-433c-4d58-ba80-ecbb0257d6e9",
"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": "16671259-aece-468c-946c-c4fcb2c9db35",
"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": "2ee56696-d5fd-4f5f-ae5e-bd635ca19dc8",
"db_country_code": "sample string 28",
"feelist_id": "d09f664e-6a73-4a3a-832c-0fec38b33510",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7ca299f6-0cf7-4934-9113-a536acc15d23",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "58fb418a-95de-46f2-877b-d06c6794af62",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-30T11:26:28.1295576+00:00",
"db_currency_id": "8dce6f1f-ecac-4858-816f-2ab9edc97ca9",
"db_currency_code": "sample string 10"
},
"company_type_id": "9db389bf-8fc4-4883-a259-c815e1bb054a",
"company_type_name": "sample string 32",
"company_type": {
"id": "3cd6b867-8287-4352-b0fd-4b561a168710",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fc3edd35-e23b-4510-9071-ed129e3a43b1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97d17e1c-e4de-4796-88e0-d4e0fb59ffc6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0b0685d8-64be-4791-8cd5-6500b193e300",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6ddf70d5-5717-45f3-97d2-0468c9a5d1fa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9bf08676-038d-444c-b658-ac1da0c6d2ff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-30T11:26:28.1295576+00:00"
},
"company_sector_id": "bd279b6e-4cd1-445e-9692-ecd891545f56",
"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": "6e698b0f-d4a7-412a-b435-17856c451329",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c28cb693-c42e-4188-a248-00251ed387a7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "134189f5-a43d-4937-b9dd-a35250c0ce8f",
"account_manager_user_code": "sample string 56",
"company_status_id": "1334da51-e2ba-4df2-a606-1441af18c7fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-30T11:26:28.1295576+00:00",
"id2": 60
},
"db_language_id": "20b4f75d-fbd6-4416-b3ba-b377aeafef8a",
"db_language_code": "sample string 7",
"db_title_id": "49d0b8ad-2c71-4380-9e6c-3b7f086a4f97",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-30T11:26:28.1295576+00:00",
"create_date": "2026-01-30T11:26:28.1295576+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-01-30T11:26:28.1295576+00:00"
}