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": "cd940b88-2ea5-4a09-819f-76b43d39b3fe", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "cb334b14-e1cc-43a8-a6d6-5afbe4949f19", "company_code": "sample string 5", "company": { "id": "12326c71-2655-4d3e-ac48-9770e893949a", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-09-29T01:23:03.3500469+00:00", "sales_territory_id": "86b77a0c-d6b8-4ea4-99c9-bbd190d6e73d", "sales_territory_code": "sample string 9", "sales_territory": { "id": "6b9be9ce-a9e4-4703-83cf-6b59d3f10fa3", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "d1ecd75b-1c4c-4c9d-82ae-b8a3a2292611", "sales_organization_code": "sample string 5", "sales_organization": { "id": "3fa9e58a-7633-4ea5-a418-c3c4897d561d", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "63c8b2d2-aa9b-4997-a0c7-0826b87dbb01", "db_currency_id": "140b0342-858d-487b-9688-09d702811e88", "db_language_id": "d01aff85-ae75-487f-9384-5e136d27d575", "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-09-29T01:23:03.3500469+00:00" }, "modified_dateutc": "2024-09-29T01:23:03.3500469+00:00" }, "marketing_segment_id": "2d71e568-f6f2-4eb2-89e4-16848b27753c", "marketing_segment_code": "sample string 11", "sales_organization_id": "f391559b-7e0c-4d0d-93dd-0fe0fa481a21", "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": "959b9948-38ea-449f-9047-c5ac00014eaa", "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": "eae888ac-1070-4b57-b5c6-613f69b9c9a1", "db_country_code": "sample string 28", "feelist_id": "c1adf50b-266b-4024-93dd-f45b7f20b77a", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "bf12cde2-7c52-4068-ae0d-19dc8dfdf837", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "1a9323c6-5bac-4ade-908b-cb0605ad9733", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-09-29T01:23:03.3687755+00:00", "db_currency_id": "eb244441-3327-4dc6-a6cc-efb446e2809f", "db_currency_code": "sample string 10" }, "company_type_id": "06f40feb-ca50-4f77-ba0f-8dba26afdc3d", "company_type_name": "sample string 32", "company_type": { "id": "32239448-e85d-4b5f-96c0-41c0a09aa778", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "db718793-63f2-488a-9eb5-645498c9a956", "sales_organization_code": "sample string 5" }, "db_language_id": "a6322718-d457-40ef-a314-49da53816b12", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "a9b021a2-d950-4f9a-b8cc-56885543d2f5", "article_price_label_code": "sample string 37", "db_payment_method_id": "9d451bfd-ef3c-4b47-b12a-7db0c4bc814a", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "ba0545a2-24ac-4822-bcc5-b5bf7eeacd93", "name": "sample string 2", "pm": "sample string 3", "description": "sample string 4", "reference_back_office": "sample string 5", "activated": true, "modified_dateutc": "2024-09-29T01:23:03.3804849+00:00" }, "company_sector_id": "a5b421bb-39bf-4b8c-8baf-97c87c4562d5", "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": "07a1fce0-aca5-4f3a-89a3-3a88c356a578", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "1e4fdade-1e4b-4e93-a2e9-719863a5ebaf", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "5f4b5271-da7c-4151-b108-40fe61c26271", "account_manager_user_code": "sample string 56", "company_status_id": "03df0888-5141-4dd7-981a-0a33cd903263", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-09-29T01:23:03.3804849+00:00", "id2": 60, "po_number_required": true, "invoice_contact_id": "e890e83b-9c69-4d94-959a-3ba398686619", "due_monthend": true, "payement_conditions": "sample string 64", "udf1": "sample string 65", "udf2": "sample string 66", "udf3": "sample string 67", "udf4": "sample string 68", "udf5": "sample string 69", "udf6": "sample string 70", "udf7": "sample string 71", "udf8": "sample string 72", "udf9": "sample string 73", "udf10": "sample string 74", "udf11": "sample string 75", "udf12": "sample string 76", "udf13": "sample string 77", "udf14": "sample string 78", "udf15": "sample string 79", "udf16": "sample string 80", "udf17": "sample string 81", "udf18": "sample string 82", "udf19": "sample string 83", "udf20": "sample string 84", "udf21": "sample string 85", "udf22": "sample string 86", "udf23": "sample string 87", "udf24": "sample string 88", "udf25": "sample string 89", "udf26": "sample string 90", "udf27": "sample string 91", "udf28": "sample string 92", "udf29": "sample string 93", "udf30": "sample string 94", "udf31": "sample string 95", "udf32": "sample string 96", "udf33": "sample string 97", "udf34": "sample string 98", "udf35": "sample string 99", "udf36": "sample string 100", "udf37": "sample string 101", "udf38": "sample string 102", "udf39": "sample string 103", "udf40": "sample string 104", "udf41": "sample string 105", "udf42": "sample string 106", "udf43": "sample string 107", "udf44": "sample string 108", "udf45": "sample string 109", "udf46": "sample string 110", "udf47": "sample string 111", "udf48": "sample string 112", "udf49": "sample string 113", "udf50": "sample string 114", "udf51": "sample string 115", "udf52": "sample string 116", "udf53": "sample string 117", "udf54": "sample string 118", "udf55": "sample string 119", "udf56": "sample string 120", "udf57": "sample string 121", "udf58": "sample string 122", "udf59": "sample string 123", "udf60": "sample string 124", "udf61": "sample string 125", "udf62": "sample string 126", "udf63": "sample string 127", "udf64": "sample string 128", "udf65": "sample string 129", "udf66": "sample string 130", "udf67": "sample string 131", "udf68": "sample string 132", "udf69": "sample string 133", "udf70": "sample string 134", "udf71": "sample string 135", "udf72": "sample string 136", "udf73": "sample string 137", "udf74": "sample string 138", "udf75": "sample string 139", "udf76": "sample string 140", "udf77": "sample string 141", "udf78": "sample string 142", "udf79": "sample string 143", "udf80": "sample string 144", "udf81": "sample string 145", "udf82": "sample string 146", "udf83": "sample string 147", "udf84": "sample string 148", "udf85": "sample string 149", "udf86": "sample string 150", "udf87": "sample string 151", "udf88": "sample string 152", "udf89": "sample string 153", "udf90": "sample string 154", "udf91": "sample string 155", "udf92": "sample string 156", "udf93": "sample string 157", "udf94": "sample string 158", "udf95": "sample string 159", "udf96": "sample string 160", "udf97": "sample string 161", "udf98": "sample string 162", "udf99": "sample string 163", "udf100": "sample string 164" }, "db_language_id": "370fa692-a0f2-410b-9480-3876faf6bbbe", "db_language_code": "sample string 7", "db_title_id": "d5ae122d-e9ae-458a-83cd-8f45ef4ae75a", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-09-29T01:23:03.4742146+00:00", "create_date": "2024-09-29T01:23:03.4742146+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-09-29T01:23:03.4898405+00:00" }