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": "e287bdb9-bb50-4446-942e-c00114b48b5d", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "517d5659-c35b-4ce3-84ea-cf3a632b3275", "company_code": "sample string 5", "company": { "id": "077b9926-2e68-4782-a76e-2abbde304021", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-01-18T05:01:52.3660629+00:00", "sales_territory_id": "609629e0-1e1b-4029-90db-fe0690babb97", "sales_territory_code": "sample string 9", "sales_territory": { "id": "b6bfccca-be7c-469f-bf01-f83d7cb9ea3d", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "3547916f-b2a9-439a-9d89-76d6eefe18f5", "sales_organization_code": "sample string 5", "sales_organization": { "id": "b48b651f-6444-4976-a5af-8756569eac99", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "ea412917-eace-407b-8266-23529fe095c9", "db_currency_id": "afa95523-64f9-44a5-ab6a-0fa6b8ba1da0", "db_language_id": "d14a851c-83e5-4e92-b96a-8a3a07010356", "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-01-18T05:01:52.3660629+00:00" }, "modified_dateutc": "2025-01-18T05:01:52.3660629+00:00" }, "marketing_segment_id": "9c6f9b14-1bb7-4efc-a515-bd3961f2ce77", "marketing_segment_code": "sample string 11", "sales_organization_id": "12ded51d-149b-4bd3-a953-2205d0a49702", "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": "0a10df7e-5d37-45e8-895e-89a4c86dd3c4", "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": "cc67ce78-a821-43f6-be96-2bf029006ac0", "db_country_code": "sample string 28", "feelist_id": "bf313e6d-aac4-45fe-8ad3-d5ef6806b687", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "5d2f5932-02fb-4bde-8c3f-653e30816554", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "63780927-3770-4520-a2c4-d56ee502711b", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-01-18T05:01:52.3660629+00:00", "db_currency_id": "28a25634-d7b2-4742-8b02-ffbe236984df", "db_currency_code": "sample string 10" }, "company_type_id": "6272cc51-f1b2-49b7-a553-ca6587bc0c8b", "company_type_name": "sample string 32", "company_type": { "id": "a42b09a0-3b20-4013-b0f1-f667c3b4f532", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "44366208-e4cb-4b2b-bf8c-7a43cb2a2767", "sales_organization_code": "sample string 5" }, "db_language_id": "8f275148-b7ba-4947-a0eb-4ab905a6fd41", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "437d6b09-dd5d-4f22-a8bf-d2f09f94ba93", "article_price_label_code": "sample string 37", "db_payment_method_id": "a6bdaca7-69ae-4adc-826f-15d620c930fc", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "08855725-3e97-4bd3-8f99-d4590d6de303", "name": "sample string 2", "pm": "sample string 3", "description": "sample string 4", "reference_back_office": "sample string 5", "activated": true, "modified_dateutc": "2025-01-18T05:01:52.3660629+00:00" }, "company_sector_id": "982d4d6c-c282-47b9-a880-20c716e0dade", "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": "9217ee06-4f56-40e9-828b-571cc903324d", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "81721298-8d23-4c76-a860-fd2638ff19f2", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "66501be1-76c3-405d-856c-617f6e3f4b71", "account_manager_user_code": "sample string 56", "company_status_id": "ce090e63-2492-4d77-b963-9bbfd40e237b", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-01-18T05:01:52.3660629+00:00", "id2": 60, "po_number_required": true, "invoice_contact_id": "c99d95f9-54a3-4409-9eaf-23721e23e45c", "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": "41d22980-0090-4735-a413-732078b06661", "db_language_code": "sample string 7", "db_title_id": "4c48adb8-01a2-4a49-b940-f0af06b4e061", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-01-18T05:01:52.3660629+00:00", "create_date": "2025-01-18T05:01:52.3660629+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-01-18T05:01:52.3660629+00:00" }