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": "a8faed86-6497-4279-a322-495db3f46385",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4b44cd63-3439-40c0-a347-40f7415055cd",
"company_code": "sample string 5",
"company": {
"id": "973a512a-5b05-4da7-9242-2f5fed4e91da",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-21T11:54:12.7096465+00:00",
"sales_territory_id": "f20c1853-4b45-428d-8828-35424d97e795",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "adea8eaf-8bf4-45f5-a3f3-418e234d775c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "753f70a0-6667-4efa-a83c-5976da1f5a38",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20d2d15e-8649-494f-8ae3-101b8bee58ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9d29184-20fe-43a7-897a-686d25c6626e",
"db_currency_id": "57aa7615-df0f-4f33-9e52-623fa2db3c25",
"db_language_id": "c5cd6727-918c-4cc7-90a2-78de449ecc98",
"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-06-21T11:54:12.7096465+00:00"
},
"modified_dateutc": "2025-06-21T11:54:12.7096465+00:00"
},
"marketing_segment_id": "2dbf02cc-d23d-4f04-a656-6ae34f8191e4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c2652609-93a1-4338-9c44-30ed05c9c648",
"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": "ae598853-f5e5-41cd-b050-327f77eb4ad3",
"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": "d92a751e-b671-4425-8b9b-a9b9bffac645",
"db_country_code": "sample string 28",
"feelist_id": "12023cdd-587b-4a6a-9832-c90e28ad4351",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "49a7a9f8-dd12-4597-832a-d5b466a77a4b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2b9644ba-fad2-4a17-91d7-9e1bbe8329dc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-21T11:54:12.7096465+00:00",
"db_currency_id": "6375f858-f24f-4d54-af71-3062ae2dd594",
"db_currency_code": "sample string 10"
},
"company_type_id": "1c043283-7773-4ad7-a685-34cdb9088d27",
"company_type_name": "sample string 32",
"company_type": {
"id": "98f09b75-32a0-4f40-b0f7-0fc7a352034b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58d5a052-64d4-432a-8578-5a994d8c099b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "54dcf946-cba1-4da0-a627-f3059aebf380",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f61f3f02-3b55-41c0-82f3-dc1ea45db4c5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00cd19de-3cb5-4928-9847-4c46c0d4edf8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "86e26720-b5f3-4b77-86a2-3ee1c7ff4b9e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-21T11:54:12.7096465+00:00"
},
"company_sector_id": "6586da08-e4b6-4939-9a21-3381dbf1f818",
"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": "67f00184-fa3b-428c-a185-1918c249e798",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "99180bb6-c265-48c3-8372-2f61b3289faa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7d1a675f-af45-4c74-b2a3-42405429dd06",
"account_manager_user_code": "sample string 56",
"company_status_id": "81774c76-5570-4ac7-bf61-54dc9d64bbee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-21T11:54:12.7096465+00:00",
"id2": 60
},
"db_language_id": "9ea5d324-1bb3-4407-ab71-f17298ba5e85",
"db_language_code": "sample string 7",
"db_title_id": "7f8df3bc-8094-41c8-8fa3-06e9fa3dedd6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-21T11:54:12.7096465+00:00",
"create_date": "2025-06-21T11:54:12.7096465+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-06-21T11:54:12.7096465+00:00"
}