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": "a1b15f84-2127-40d2-8a14-91807895fedd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dd3f5029-4d9d-4453-8bce-70ddc50eaa06",
"company_code": "sample string 5",
"company": {
"id": "9b7d1757-7b30-43a6-903b-a82c0acd119a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-02T19:38:42.0961442+00:00",
"sales_territory_id": "bb2b3ab4-c910-45f6-a561-e9b42aee85a4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "02ca105c-f52f-4403-a030-a7787102d9af",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a2e1908-dabe-4247-b4b5-3ee64c610bba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3ea06b4a-43c2-4db4-ad1e-9e2a571ebf96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "899593fa-4abc-4037-9536-5e5f68555d17",
"db_currency_id": "79c18c35-8131-4705-9d29-5c99361e0b71",
"db_language_id": "e2c89530-1e6a-407f-b165-25afb65e3f4d",
"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-10-02T19:38:42.0961442+00:00"
},
"modified_dateutc": "2025-10-02T19:38:42.0961442+00:00"
},
"marketing_segment_id": "216229cd-df0c-4d54-a62d-0e25007a639c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "591daac5-4bb9-4b8f-a9d3-f1216d05cafa",
"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": "558091d0-dfe2-4ce2-938c-869fa0784143",
"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": "16e725d4-374a-4ff2-8f9c-af2c5249a54a",
"db_country_code": "sample string 28",
"feelist_id": "0880ba41-24b3-484e-84d2-19e83a936eea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e01c34cb-cd92-4bb5-a76a-ef0b781aabfb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "167171d9-3d81-4b89-b704-b9f4ad87f228",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-02T19:38:42.0961442+00:00",
"db_currency_id": "222d7223-7f1b-493c-bc5e-6d78beef7488",
"db_currency_code": "sample string 10"
},
"company_type_id": "769d4571-3881-4f7a-a0ce-5f1a15d3a3d5",
"company_type_name": "sample string 32",
"company_type": {
"id": "d1ffc305-1d93-4084-93f5-49acd8b14697",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d86d2935-940e-4c8c-b2a0-91e3b81ba69c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f6057d58-5850-4ab1-8fd2-c701a326456d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3a47da25-5ffe-46d5-9c56-28b458e2b7e2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f234be4b-2094-48ae-b23e-06b55f164220",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a3ed5052-d21d-4c82-811d-5a6d5aa6952f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-02T19:38:42.0961442+00:00"
},
"company_sector_id": "6ea9fc97-b9bd-4287-a7f9-db4e11f1a7f5",
"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": "1e3b9e5f-506f-4eff-9f9c-b34592a217b5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "18f4f141-14c8-4d10-abde-d12d4e38dfee",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "94156bbe-cf35-47ba-9f1d-f84b51e9ea6e",
"account_manager_user_code": "sample string 56",
"company_status_id": "97e41aae-f2e9-4c34-81c8-b73539306eef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-02T19:38:42.0961442+00:00",
"id2": 60
},
"db_language_id": "ca33a98d-9685-4501-a8d7-247c21a01380",
"db_language_code": "sample string 7",
"db_title_id": "d1f28da2-528c-4c85-b1a8-08c31bb0779e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-02T19:38:42.0961442+00:00",
"create_date": "2025-10-02T19:38:42.0961442+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-10-02T19:38:42.0961442+00:00"
}