Get Contact by email
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
Email of contact |
string |
Required |
Body Parameters :
None.
Response Information
Resource Description :
contactName | 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
{ "id": "392687fd-6e32-441d-af9d-a25af1b6daf4", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "2fee251c-46a4-4956-83c1-6d21e29e6bbd", "company_code": "sample string 5", "company": { "id": "a2c84b13-b0f4-4e70-b337-e83d0b9219f5", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2022-08-08T05:38:17.8790154+02:00", "sales_territory_id": "1da62926-c9ca-4bcd-b404-888435b4bad7", "sales_territory_code": "sample string 9", "sales_territory": { "id": "6b77b1e0-7cb5-4a5e-9528-ac78d5324c53", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "e00b4e53-f5a3-48dc-a8a1-41875ad0741a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1a4502c1-3136-4065-9a3d-a60616bb3e2b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "f657961d-bcda-43ce-bc8a-f10fab0e0abe", "db_currency_id": "bcea1eec-5db1-40d1-9b0d-803ee202de4a", "db_language_id": "98a6d1d5-c415-40db-bbfb-994af0749f70", "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": "2022-08-08T05:38:17.8790154+02:00" }, "modified_dateutc": "2022-08-08T05:38:17.8790154+02:00" }, "marketing_segment_id": "fd3002da-c779-4be7-9c71-aee7835ac4fa", "marketing_segment_code": "sample string 11", "sales_organization_id": "0d4999ef-2a48-42c0-9e87-fc9955fb833f", "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": "74c5375e-1848-4a8e-9f8d-0ddef401bd9d", "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": "4a348395-48a4-46c6-893d-5494da7ff7be", "db_country_code": "sample string 28", "feelist_id": "fee37658-fc2d-48fc-a02e-3098734f0968", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "726378dc-d204-4e3d-8f87-20337d4cee48", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "7f67985c-0885-447a-846b-c519e9d70e85", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2022-08-08T05:38:17.8790154+02:00" }, "company_type_id": "dd8ab7e1-11d0-4bb5-a575-319328d81779", "company_type_name": "sample string 32", "company_type": { "id": "1041c1d3-abda-4ae5-a5f9-eb7777cd3380", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "608b7fe9-0e96-4a9d-a14c-c0c922903458", "sales_organization_code": "sample string 5" }, "db_language_id": "0105ec90-5b2d-49ad-b136-48e84bd0dbf1", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "301173a2-6c24-4841-aa3a-61eecf5ce57e", "article_price_label_code": "sample string 37", "db_payment_method_id": "1652935a-1380-4a7c-b688-d0ef3cba10e4", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "af8df5a8-29bd-4c4b-95d4-081aeab87efd", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2022-08-08T05:38:17.8790154+02:00" }, "company_sector_id": "5293792c-73fd-4e7f-b5c2-5d2a599dc99c", "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": "5991f724-22c7-4e33-9e13-0203e08abd5b", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "5622c3b4-72a1-4542-a0ea-e2ac922d30e4", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "c1a39192-3ff8-467a-8cc4-03edc96c9bf5", "account_manager_user_code": "sample string 56", "company_status_id": "68aea1ed-e122-47aa-89c3-d66517812799", "invoice_email_to": "sample string 58", "modified_dateutc": "2022-08-08T05:38:17.8790154+02:00", "id2": 60 }, "db_language_id": "4e147765-3e44-4d38-88b9-dc47b41606d3", "db_language_code": "sample string 7", "db_title_id": "4b6e2eb5-5978-4cf3-9539-c71087eb780f", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2022-08-08T05:38:17.8790154+02:00", "create_date": "2022-08-08T05:38:17.8790154+02: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": "2022-08-08T05:38:17.8790154+02:00" }