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": "ee180bb1-8b8c-4d97-8db7-d030939c994c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9af79f48-2240-49ef-b2b0-03e60dae5be8",
"company_code": "sample string 5",
"company": {
"id": "57075abf-98ac-4464-81e7-8a486b5d2dd7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-24T10:59:49.4946489+00:00",
"sales_territory_id": "52220777-511a-4e8f-9cdd-39d196a86928",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9bce3a6e-8d00-4575-b05c-6352d41814c3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a378d13a-8c4e-4d7e-8029-4e0ef0c0597a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ee0127ea-14a9-48c1-b561-1db751f2dc3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4ce0b0d-caf7-495b-aaf6-50f2b28024da",
"db_currency_id": "db386a63-424c-415c-a892-9d498ed68627",
"db_language_id": "84472153-8f54-48e5-b33b-bf7a6ea41e16",
"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-04-24T10:59:49.4946489+00:00"
},
"modified_dateutc": "2026-04-24T10:59:49.4946489+00:00"
},
"marketing_segment_id": "6c6ae3eb-80e1-4734-a15a-b892da786675",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "781d218b-a93e-4986-b696-17e28ba6f2ec",
"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": "55abeee7-9ece-49b9-b422-d55fa91e2d43",
"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": "e3d2b608-357c-4375-b9bc-c98072ad38b7",
"db_country_code": "sample string 28",
"feelist_id": "1d055d23-d7d1-40ea-9a61-f7c108ed9cd1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f8e7422d-efe1-40c7-a43a-af15c9a0d0d6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "692153f5-a6b9-4a18-8d58-7b38e3f8f14a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-24T10:59:49.4946489+00:00",
"db_currency_id": "4c95f16f-03bd-4420-b473-1c752c991418",
"db_currency_code": "sample string 10"
},
"company_type_id": "c5d906d9-98cb-4740-9e75-755d1d060ba6",
"company_type_name": "sample string 32",
"company_type": {
"id": "f1688a86-e6a1-4e68-b635-1709751063e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "166ce599-82e2-47c0-8f50-710c80d815a4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9a298488-c0e7-47d4-887c-624f36731c65",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "58d2f0f9-a8bc-4740-9349-1bfd9dbd2e67",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f3bfbe8b-8259-43e0-b5b3-2b614c3b1d2f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c5491163-dcca-4ec2-9471-183358f539f5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-24T10:59:49.4946489+00:00"
},
"company_sector_id": "8ec4e792-cfae-497e-ac07-6bcd4794abd3",
"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": "05b6d484-373c-4af6-bb92-657f9b6137e0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "974c60c8-0354-4472-8d86-6ef3ffc36f13",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "91a0d87d-3bea-4431-b8db-8733be75aed3",
"account_manager_user_code": "sample string 56",
"company_status_id": "bd427e73-77e1-4968-a9ed-351199df2573",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-24T10:59:49.4946489+00:00",
"id2": 60
},
"db_language_id": "937753cd-4804-4774-9024-e68502410268",
"db_language_code": "sample string 7",
"db_title_id": "7d0028e1-fee4-48aa-bb05-d5684bde23fc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-24T10:59:49.4946489+00:00",
"create_date": "2026-04-24T10:59:49.4946489+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-04-24T10:59:49.4946489+00:00"
}