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": "00eca3a2-bd2f-4eec-92b4-cf4b49342f88", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "9abeb0a6-a4e6-45a4-917a-19c3705b69ee", "company_code": "sample string 5", "company": { "id": "7de98b42-afec-419b-b3a9-6ff2522cf2a0", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-04-18T11:01:16.6236369+00:00", "sales_territory_id": "61dad75a-e8d1-4dd9-88d0-85009774166e", "sales_territory_code": "sample string 9", "sales_territory": { "id": "ffcd8b4e-3e02-4295-8de9-e703f637c3a3", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "6420d7cb-869a-4e85-a6aa-7282b0071ceb", "sales_organization_code": "sample string 5", "sales_organization": { "id": "0d48a8f3-1eae-4610-8a0b-5833c644f53b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "923ff326-1b40-4720-a97d-14c02c05de9a", "db_currency_id": "475d14d3-a3bb-4a47-b70e-94ac0f3d9ac9", "db_language_id": "adb84470-d4d4-426a-8d10-64e0d47d524a", "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": "2024-04-18T11:01:16.6236369+00:00" }, "modified_dateutc": "2024-04-18T11:01:16.6236369+00:00" }, "marketing_segment_id": "e7e1f3db-2fdb-48b7-b16e-b2dbedac159d", "marketing_segment_code": "sample string 11", "sales_organization_id": "8f8faaf5-bdd4-45d6-97b5-45358cc94c93", "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": "0f97d47f-8dbd-4c90-a806-1be08f0fa15b", "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": "c4a0e27a-2636-411e-b202-e425c78a3a5c", "db_country_code": "sample string 28", "feelist_id": "eadca879-776b-4f0f-b1f8-c36c3e054b76", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "75932779-656a-4cf7-9e2c-362f816a0539", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "1447e4f9-5211-4245-8235-ee0afafcd718", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-04-18T11:01:16.6236369+00:00", "db_currency_id": "6c3f0f50-10e0-4ed3-9438-c22acc2f9619", "db_currency_code": "sample string 10" }, "company_type_id": "be7cdfc7-e52b-4888-9776-053e83d8b1ac", "company_type_name": "sample string 32", "company_type": { "id": "66d9a149-90cb-4b41-bf70-d14decc46353", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "1935e15d-ae15-4fbd-b56e-cca8f4ad718e", "sales_organization_code": "sample string 5" }, "db_language_id": "7d3e2f4f-dda3-4fe0-8bfd-2441cf2e6c05", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "64ebfc0e-e89a-47c9-90d9-17a82fb35d08", "article_price_label_code": "sample string 37", "db_payment_method_id": "c03ef6da-6517-4bb3-b05c-e569a55119b9", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "a355edcf-83c7-49a5-aae6-53bc2b149464", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-04-18T11:01:16.6236369+00:00" }, "company_sector_id": "3b34354a-04cf-4cae-841f-4eea4bcafa5f", "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": "b9f76f3f-d5a1-40d8-8426-3ea5b816bba2", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "daf1c227-fc4d-47ba-928a-bd24fc803960", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "4f12658a-40a3-4089-82fe-d9ddebd3dc13", "account_manager_user_code": "sample string 56", "company_status_id": "ae6236e2-e6a0-4398-afcd-c5fdab69756e", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-04-18T11:01:16.6236369+00:00", "id2": 60 }, "db_language_id": "6550624c-a22c-41df-968d-1aa9eb4bc18f", "db_language_code": "sample string 7", "db_title_id": "1c0ffc3c-9614-4019-a216-cfabe4f2dc93", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-04-18T11:01:16.6236369+00:00", "create_date": "2024-04-18T11:01:16.6236369+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": "2024-04-18T11:01:16.6236369+00:00" }