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": "858d5dc2-eeb0-4bdc-a8db-2a9e6845d560",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1307a7a1-6fef-494d-b225-a539d03a5222",
"company_code": "sample string 5",
"company": {
"id": "16ebf297-e256-49d4-87d5-4dc63f2b39e4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-14T04:36:00.9862525+00:00",
"sales_territory_id": "cead853a-636d-4179-bcaa-41dbcbda0ba4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "73a40f71-f775-4a73-bcf1-83f59009a8f4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3dce9737-a197-4eab-88ab-a2c140905a19",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5b830ea3-3a60-4d4b-88fe-902b0447ab31",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3b0e148f-3b02-47c1-825d-1c25e9b599bc",
"db_currency_id": "d2c72683-f4ee-460a-90c6-897885b81f82",
"db_language_id": "8f5374bb-2cd8-4c63-9bd6-1b0e15cd363d",
"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-05-14T04:36:00.9862525+00:00"
},
"modified_dateutc": "2026-05-14T04:36:00.9862525+00:00"
},
"marketing_segment_id": "81d18fb0-b9e5-40a7-ae1f-813d4dfc98c6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ea7d24fa-6fe3-400e-8ee6-59a351fa33d9",
"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": "8f86d8f9-438b-4eca-8b29-f9a6b383d06c",
"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": "201bd7eb-ce37-4140-a433-1fe1f77c7b5b",
"db_country_code": "sample string 28",
"feelist_id": "68fdeeff-12ae-4280-8121-55c67a152659",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4f5de840-9c0b-4821-88bd-144f1d3324ae",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cedf9f0d-3b04-4a8c-8686-75ffab3138d3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-14T04:36:00.9862525+00:00",
"db_currency_id": "e67ab919-890b-411c-8cd0-c8a139229d88",
"db_currency_code": "sample string 10"
},
"company_type_id": "80a7a4d4-ed9b-4009-b0ed-29ca14de2aa4",
"company_type_name": "sample string 32",
"company_type": {
"id": "3abe1757-b436-4040-9479-d2db1ce02dfe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "41b55658-6176-4c12-8226-945d89ccf2b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8d11d141-ef02-403c-8fa7-b72aa59daf3c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8d2ed76c-eea9-4efe-bf8c-42c8f8bae0fb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "396b707d-2929-4c7a-8fc2-67761cbd1482",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "198c0fa2-048e-422f-a70e-afd9a134dbfe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-14T04:36:00.9862525+00:00"
},
"company_sector_id": "55a0947d-9b1e-444b-8ef9-d374c5ce70a5",
"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": "166dfbfc-7dcf-44de-8869-30e79cf483c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "20ad29c6-b504-4a39-bfe9-ac18d1b95486",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eea26355-6990-4196-a305-f6f9ac7f79f3",
"account_manager_user_code": "sample string 56",
"company_status_id": "5712935d-3805-444a-8cdb-3f4296a35a9b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-14T04:36:00.9862525+00:00",
"id2": 60
},
"db_language_id": "1d1b7150-a6f2-4960-9321-6894a7965737",
"db_language_code": "sample string 7",
"db_title_id": "49495e77-cdba-4325-843f-d3038914712d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-14T04:36:00.9862525+00:00",
"create_date": "2026-05-14T04:36:00.9862525+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-05-14T04:36:00.9862525+00:00"
}