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": "fdbb9e47-f540-4551-9058-c2bc1acdf740",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9f543a6c-0507-43cb-84ab-e3eb44c6c116",
"company_code": "sample string 5",
"company": {
"id": "fb2bbe10-3ec4-4ebd-a691-91d42b14559c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-21T21:04:03.9077824+00:00",
"sales_territory_id": "b5b44f90-7b9a-4199-bdb5-8a381d4b8fca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e3ec1f8a-e287-466c-b444-2e124a5abfdf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9cb08b7d-1ff3-4336-811d-308e386c3bd0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65588995-9b6e-4138-a478-50e63e6a806c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01cf4f8c-fb42-4599-ab6a-7b08ca8bb251",
"db_currency_id": "d9f91df5-e3ea-457c-b65b-67a8e2a9516b",
"db_language_id": "5cd82999-6919-434e-89e9-024413fec2f7",
"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-21T21:04:03.9077824+00:00"
},
"modified_dateutc": "2025-11-21T21:04:03.9077824+00:00"
},
"marketing_segment_id": "1e6df113-a3e6-4356-81d7-c34b109e5807",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "27a6e2d2-6916-41da-97a8-f2fd148ba460",
"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": "abd6f51d-6d20-41e7-8ed5-894cfb00c75f",
"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": "4d6ff5e7-4d39-4108-840d-123f9dd92ae4",
"db_country_code": "sample string 28",
"feelist_id": "121da6fb-7e92-4568-8105-94918ab79ce7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e31140a4-d8fe-457a-a0aa-ad29bc33db7d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d61aa4d0-150a-456b-9d82-347f1bc65fb3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-21T21:04:03.9077824+00:00",
"db_currency_id": "31fab72a-f338-4b46-b9b9-f926ac5899fb",
"db_currency_code": "sample string 10"
},
"company_type_id": "d92cdd4b-ece9-4884-bccd-a84fd711eb31",
"company_type_name": "sample string 32",
"company_type": {
"id": "11773f4d-260d-4f32-8907-f459e0af481c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9093269b-dd28-489c-af49-57c4bc369c10",
"sales_organization_code": "sample string 5"
},
"db_language_id": "43e68a2e-481e-46e7-a4ed-57c4c19f4e71",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e74454f2-6c13-4c23-b04a-d6db76938f28",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "72ca7d4b-bf62-4374-9bcf-44b7e94e3dcd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fc996bba-7e55-4578-b9f3-24cd54a802a6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-21T21:04:03.9077824+00:00"
},
"company_sector_id": "09fd70c2-5d17-46a6-b6ae-e55a2c65fb67",
"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": "a48d2a27-5c46-419b-a0cc-51246e291074",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "525c63f7-1354-4209-9ced-ffab1a60ecd9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e12d3186-b56e-4d73-bdf2-a07870cfc7ae",
"account_manager_user_code": "sample string 56",
"company_status_id": "d53e6aa0-d3be-47f5-8b06-4904c62f83d4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-21T21:04:03.9077824+00:00",
"id2": 60
},
"db_language_id": "49495602-bcd3-4af1-b549-9406afc1e72d",
"db_language_code": "sample string 7",
"db_title_id": "b39e5065-b76b-4621-8770-d662c3aa8dd3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-21T21:04:03.9077824+00:00",
"create_date": "2025-11-21T21:04:03.9077824+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-21T21:04:03.9077824+00:00"
}