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": "a953a2f1-84ea-4030-8cce-be07c3c26ca3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "49caa763-4ace-4f25-bba4-3c81048a6cba",
"company_code": "sample string 5",
"company": {
"id": "a930868f-7fae-4781-bbbf-b5737299f9f2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-16T16:50:21.3986993+00:00",
"sales_territory_id": "8b87a940-5ef5-453c-8f20-5df6dd49ba42",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "41cf3f65-4803-4bb5-ba86-2df7ac5fca41",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "204996af-8fe1-4742-a228-77759c83620d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34e3ec99-61bc-4760-a242-31a921195d44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7032c8e-b9ed-4e80-a13d-fac21d7d143b",
"db_currency_id": "16b1cb5c-6090-439c-8c5b-492dcd1b3c33",
"db_language_id": "6a151771-16f7-4d01-8f77-a42f8b1be834",
"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-05-16T16:50:21.3986993+00:00"
},
"modified_dateutc": "2025-05-16T16:50:21.3986993+00:00"
},
"marketing_segment_id": "09d35419-954e-4687-a47d-79055a90d1ec",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "06467131-5b35-4186-8f98-0578403dc387",
"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": "4279e67d-2209-41a8-bcc2-eafa3e2f7c2d",
"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": "4d4b0217-b796-47eb-b03f-46827bf73431",
"db_country_code": "sample string 28",
"feelist_id": "2c7a99aa-afd2-4b5f-aa57-7746956e7d94",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3b32941b-a675-4485-8636-05c85a86384f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7150e374-f9f2-4398-9714-1c41a874a274",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-16T16:50:21.3986993+00:00",
"db_currency_id": "e14e1e1d-a1b6-4192-a1e1-d243d891c6ad",
"db_currency_code": "sample string 10"
},
"company_type_id": "e4417c44-5e97-4763-b107-67016d02fab9",
"company_type_name": "sample string 32",
"company_type": {
"id": "2080aa54-993c-4fd4-b31d-fb48a63191b0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f6a81784-e063-4610-804a-983fa541ef91",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0764290d-e538-458f-967b-2ef17f14477b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "24e999a9-719c-435e-8b41-ac35f7b5d733",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "af75f3c1-78a6-429b-90c1-c10ae0f33cbe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "13abdf4e-77fc-423b-abd3-9be3656d8241",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-16T16:50:21.3986993+00:00"
},
"company_sector_id": "bdf0d919-3238-4e8a-864e-74f363521cfa",
"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": "c132929b-6d6f-4da7-b0f0-cc3c582feb46",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fcc91165-deb2-46c9-b8cd-318aea26c87c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f27416b3-5fa6-4161-a722-514ef687bf88",
"account_manager_user_code": "sample string 56",
"company_status_id": "593d0698-efc5-48cd-b306-4da170c9b070",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-16T16:50:21.3986993+00:00",
"id2": 60
},
"db_language_id": "2da01ba6-eb79-4439-acc5-a8545faf0cd2",
"db_language_code": "sample string 7",
"db_title_id": "e0770458-c9e7-4282-867e-014065f5bfcb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-16T16:50:21.3986993+00:00",
"create_date": "2025-05-16T16:50:21.3986993+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-05-16T16:50:21.3986993+00:00"
}