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": "8fe03ebf-e022-46b0-af6e-43b6fa77657f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7086de66-2c14-45a8-a6f0-65030691affb",
"company_code": "sample string 5",
"company": {
"id": "0a8e5d0d-5e15-4877-ab72-c6cd5e844bbd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-10T22:24:29.7900253+00:00",
"sales_territory_id": "c7f083c7-b7b0-43fe-85ba-4277f678120b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f78678c8-d020-48ae-b181-aabaea0dcf36",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8091a65f-df95-4280-9c90-6fc19465657f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "31cefaaf-fe3c-4bc6-8754-619a93a65722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "479b72dc-7825-403b-b8c6-80e888336c51",
"db_currency_id": "d61122fd-b368-46f1-a523-ea53374cc14e",
"db_language_id": "713052ff-dc61-437e-ada8-09d8d019d02f",
"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-10T22:24:29.7900253+00:00"
},
"modified_dateutc": "2026-10-10T22:24:29.7900253+00:00"
},
"marketing_segment_id": "8b10182b-df4d-4d7b-bb7a-c5eca8549244",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a8634e57-db0f-4868-8b02-001b3d5cde06",
"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": "f47bd738-d46f-4d9b-9fa6-89898ec522d4",
"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": "161ee5b4-789b-436e-9b15-a325940c484d",
"db_country_code": "sample string 28",
"feelist_id": "d8ab0920-213f-455e-b389-4765893254ad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6c586aae-a582-40c8-8ac6-0849257c8d68",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "263869c9-ccdd-4813-9265-3ff91231e59f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-10T22:24:29.7900253+00:00",
"db_currency_id": "a6d2fa7a-ed99-4aec-a781-4cd4237a2122",
"db_currency_code": "sample string 10"
},
"company_type_id": "ff6835b2-d494-485f-bf94-c0904781b45e",
"company_type_name": "sample string 32",
"company_type": {
"id": "1a0d0d9f-4867-455c-b06a-72755020626d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "53802dd2-dd78-429e-b05f-fcc658407458",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b85772aa-ce7c-4ebd-ba53-b4e2a2caf08d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f46b20df-26c5-42d2-9cd4-7adfe2a9a0a8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bc93c1e5-1faf-49ea-b29e-093e074e02b1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f769a660-2c4e-48c9-9c64-cb24513bcfcc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-10T22:24:29.7900253+00:00"
},
"company_sector_id": "c001edc3-fd6e-4565-bd0f-57e46914363f",
"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": "dddf9e9c-cc99-4626-8eed-f365f4128a75",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8fc6612d-ee1f-4894-abdf-d5844a4bd487",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0d94717b-2be4-49d5-ba45-e6fd42d8ebdd",
"account_manager_user_code": "sample string 56",
"company_status_id": "deffa2be-bb10-408c-a36b-fc06fc431110",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-10T22:24:29.7900253+00:00",
"id2": 60
},
"db_language_id": "81a1b16c-cd17-4cfb-9e84-7802ba7a67ac",
"db_language_code": "sample string 7",
"db_title_id": "ef14d2b3-d71c-46d9-b613-ee5b3a769bcb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-10T22:24:29.7900253+00:00",
"create_date": "2026-10-10T22:24:29.7900253+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-10T22:24:29.7900253+00:00"
}