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": "be660374-b529-418d-91d6-f6643944d44d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "438804cc-9dba-4a6b-be5c-89a3c734cf69",
"company_code": "sample string 5",
"company": {
"id": "da01f56d-cfac-4e42-9ee5-c97f957007d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-17T01:10:57.792468+00:00",
"sales_territory_id": "5ddac210-a375-4b4a-8d7c-34b2359c5bc8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cb43864b-1e00-478f-9057-875aa7198274",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc97e111-489f-46d2-9015-33430055ac8b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "67b4e8b4-9458-43cf-81b0-e0a25c709141",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d11df46f-bff0-451e-a299-31cde2333daa",
"db_currency_id": "10ae1216-df04-4255-b178-29f87b22258d",
"db_language_id": "b2dddc4d-ac81-4012-a2ca-4358fd60b88e",
"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-11-17T01:10:57.8080883+00:00"
},
"modified_dateutc": "2025-11-17T01:10:57.8080883+00:00"
},
"marketing_segment_id": "8f234d34-dd69-4c85-a3a6-c16caf9c7ea4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "abf71102-699b-4250-b000-cc08b1baf56b",
"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": "13ac0adc-aef9-432d-b14c-9850d2eb2bd6",
"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": "4b2adf3f-3ecb-4aec-be2c-dbbeb7be2f59",
"db_country_code": "sample string 28",
"feelist_id": "ac45fb78-2447-4b6a-8844-9df865a66d77",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fdbed3f1-aa63-4b12-86c3-4d7da487b580",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f2eb1636-9b61-4007-a979-6923bafee2a7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-17T01:10:57.8080883+00:00",
"db_currency_id": "2033ff2b-fe1e-4785-aa90-3260b19cb937",
"db_currency_code": "sample string 10"
},
"company_type_id": "068c572a-0637-4945-a6b8-ba4ca2471428",
"company_type_name": "sample string 32",
"company_type": {
"id": "384fc8ef-13a5-45db-918f-5feb274f5146",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4ceaa4a4-4bb2-46a4-86ab-b9b0bdd1d07d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a72f128a-d8ca-4a54-b5fe-dbc808b82713",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "985eadbd-1238-4842-971b-5de4d5b758ab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b19536cf-f20c-48d4-8a67-dfdf3156d8a6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "075b3130-baad-425e-a11a-3bf086c51178",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-17T01:10:57.8080883+00:00"
},
"company_sector_id": "08fdf04c-bdaf-49ae-a74c-a24d686577e6",
"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": "64fde47d-01d6-476f-b09b-7d27779b11ef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f9563d54-bd08-4ef0-bfd8-74520198a983",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "25c933ec-c650-4b3a-9c71-e75df12812ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "a6fd582e-256b-4647-a762-340e771e9269",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-17T01:10:57.8080883+00:00",
"id2": 60
},
"db_language_id": "0f3fa255-e850-4ecd-b423-7a1d7dd40e20",
"db_language_code": "sample string 7",
"db_title_id": "660f72cc-73e1-4f8d-b940-b71c111939de",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-17T01:10:57.8080883+00:00",
"create_date": "2025-11-17T01:10:57.8080883+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-11-17T01:10:57.8080883+00:00"
}