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": "ac3fd006-735a-4862-b73b-92b778b730da", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "f33d5443-0ed3-4719-8544-f271a4b63c19", "company_code": "sample string 5", "company": { "id": "136ff568-3e43-43a1-969a-4d6d6c91ad31", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-03-27T08:58:46.2661711+00:00", "sales_territory_id": "acb1c48e-0d1f-4de5-a479-dd87a1ca0aa5", "sales_territory_code": "sample string 9", "sales_territory": { "id": "b5ae7241-0955-456f-bd5e-84dc9dc72cd5", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "7dd13caa-200c-4270-8d19-5bc1432f3676", "sales_organization_code": "sample string 5", "sales_organization": { "id": "a8f4714b-acc4-4fdd-b3e3-3be082a2831b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a4173094-9630-4f1f-b55a-4eff277afa52", "db_currency_id": "827a0bc5-9853-40cd-a871-4aa5320d1578", "db_language_id": "e68272dd-42c2-4dce-84a5-e7e29bcc04e5", "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-03-27T08:58:46.2661711+00:00" }, "modified_dateutc": "2024-03-27T08:58:46.2661711+00:00" }, "marketing_segment_id": "389ae60a-51ca-4d74-b463-f70649f91eb9", "marketing_segment_code": "sample string 11", "sales_organization_id": "e2ba91e6-3394-406f-8b0c-6ef277e3f3fc", "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": "ebc7bb45-deed-4a1b-8aeb-864829ee55f6", "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": "813499e5-4c8c-457d-9b1f-ec7050ca758e", "db_country_code": "sample string 28", "feelist_id": "54b024d1-7ce2-4cac-b3a2-83b8460d0014", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "8b08af51-8852-4b5e-bea8-7bdcb35d38f6", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "194bc11d-d8f8-46f3-948d-e4f4e5f178a7", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-03-27T08:58:46.2661711+00:00", "db_currency_id": "30d6398e-4807-45b3-87c7-7ba85aa1d85e", "db_currency_code": "sample string 10" }, "company_type_id": "49c705fb-9dbf-4afa-8107-a9b3417898a7", "company_type_name": "sample string 32", "company_type": { "id": "7ac399e6-cc59-4355-a931-cd1d3c6ceeed", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "726e06fe-14d4-45eb-8237-1e5d332464b4", "sales_organization_code": "sample string 5" }, "db_language_id": "c003eb96-70b6-48ca-a051-47b7bdd62b4f", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "cf4e70a0-3ca1-4fec-9f2c-a643b75d89fb", "article_price_label_code": "sample string 37", "db_payment_method_id": "8840b8d1-6811-477f-9b74-24834c09ce58", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "0d393080-1ab0-4b28-b712-0346dff3c68c", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-03-27T08:58:46.2661711+00:00" }, "company_sector_id": "1b8fa065-cfeb-44f3-9f05-b6bb36911bb4", "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": "82a2a49f-2a6c-4d09-b840-401e5fd09717", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "bee3ef8a-a9f8-4485-9036-95bff06af6e6", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "1484252b-f40e-4fee-8d84-b93ab8e22524", "account_manager_user_code": "sample string 56", "company_status_id": "ae85d68d-00d8-46f9-ba85-0e678e1e56f9", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-03-27T08:58:46.2661711+00:00", "id2": 60 }, "db_language_id": "6939e08f-5082-4f64-92eb-04d4b8f109e4", "db_language_code": "sample string 7", "db_title_id": "d0c5d9c2-91c7-436a-a662-724d7ae06c0c", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-03-27T08:58:46.2661711+00:00", "create_date": "2024-03-27T08:58:46.2661711+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-03-27T08:58:46.2661711+00:00" }