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": "28baff91-3f5e-4320-8f47-6c0731377ed7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "99630624-83fb-4898-8a70-6e56b435914b",
"company_code": "sample string 5",
"company": {
"id": "5ebb5cfb-7696-40bb-83ba-0f373cfea005",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-23T21:01:14.8693241+00:00",
"sales_territory_id": "5ed1fd85-7e68-4a08-a86d-573e7f79ffe2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7e913153-851f-4741-930c-6406a5e2c8ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bdf2fe0f-4a54-4449-a1d7-89bfd1477b76",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f0f055a3-dc03-414e-85b2-e504a7356c4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a845e2c9-3150-4da5-ac9b-4f5893064561",
"db_currency_id": "5e342af0-7bf6-483b-b605-43299c67c33a",
"db_language_id": "6290b3ed-54e8-40a6-9b31-ad6dc4d75b06",
"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-04-23T21:01:14.8693241+00:00"
},
"modified_dateutc": "2025-04-23T21:01:14.8849455+00:00"
},
"marketing_segment_id": "d764c275-0d58-4ea6-b07b-416fadfb97de",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1e3970f0-039a-47ea-9ea8-47d8e0115ccc",
"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": "c7d1ddc6-3003-4ce1-a721-14752ae679fa",
"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": "6e872566-0d90-405c-9a61-65175c8c09c9",
"db_country_code": "sample string 28",
"feelist_id": "4c995d76-73fa-46f1-89bf-0d9d9c8a6274",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cc0f657a-eb03-44c2-9be2-d68e29fc53a1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bfbdf387-2676-4d7b-9f01-2f25bacf0f38",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-23T21:01:14.8849455+00:00",
"db_currency_id": "1346b9ab-bcdf-4f23-a5c7-2dfa9f7ba276",
"db_currency_code": "sample string 10"
},
"company_type_id": "26c51705-6ac7-47c8-afb9-6aa08c5b9817",
"company_type_name": "sample string 32",
"company_type": {
"id": "e317dea4-6793-4a10-b3da-ebc4dce2f882",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "08b520c4-9a0a-40ed-9039-80ca1224f2c1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "250c0420-2c42-4bd9-a462-207ede764694",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5a335171-3338-4e6c-a23e-db6b62ab4bf1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5f8e9f76-86f6-4cf0-afc6-0b61f8d2f8b2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "165eb647-308c-49d5-881b-43968d7f562c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-23T21:01:14.8849455+00:00"
},
"company_sector_id": "6b623d52-ff0a-48d1-bd87-ef59a133242d",
"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": "351f166a-2e91-4537-8db5-88cd57bcf6e7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b152427c-96bf-4d75-a1a5-d7f3aed98856",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "439d9a0b-b5ca-4879-b72b-6eb0c4264e8d",
"account_manager_user_code": "sample string 56",
"company_status_id": "ab749ff1-1c84-478a-8afb-11e9038edae6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-23T21:01:14.8849455+00:00",
"id2": 60
},
"db_language_id": "ed5489fe-a7c4-440c-af6c-e2f4992dc6f6",
"db_language_code": "sample string 7",
"db_title_id": "7e61bd72-8329-43d4-bdee-7e7f3d2e3617",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-23T21:01:14.8849455+00:00",
"create_date": "2025-04-23T21:01:14.8849455+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-04-23T21:01:14.8849455+00:00"
}