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": "e71e7017-1411-4b32-a965-6c54250c990f", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "580f186b-dd44-40ae-9f66-64ce8ca62a86", "company_code": "sample string 5", "company": { "id": "6e11dd96-e9cf-4c57-8769-5a26e14ff090", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-10-14T01:49:46.202235+00:00", "sales_territory_id": "eb104cc0-1d65-4367-8b2b-a96fddc5bc10", "sales_territory_code": "sample string 9", "sales_territory": { "id": "cd2997ee-9ed7-4a7f-8ef9-c5ba8f4342a7", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "975a0fe6-c660-4e85-bde8-da61d405434d", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c3e3ff2e-e101-4294-a556-236a5b2821a7", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "eafb1d43-bc2f-46e9-b867-6dabd951bee2", "db_currency_id": "bae406e3-158d-4d69-963e-c30adabbd796", "db_language_id": "ad015263-0f82-461a-a56a-6d36d09bd20d", "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-10-14T01:49:46.202235+00:00" }, "modified_dateutc": "2025-10-14T01:49:46.202235+00:00" }, "marketing_segment_id": "9d933e5f-7a47-495f-b841-803630535165", "marketing_segment_code": "sample string 11", "sales_organization_id": "7caf5721-a014-40d4-8908-7e77ad4a57f0", "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": "9c38a781-4286-4f3d-b85c-91627fb64108", "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": "ec28f971-a8e7-4464-a844-95d3a37762b1", "db_country_code": "sample string 28", "feelist_id": "a45ded9a-afc8-4480-8dcb-479ea7f540df", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "57cb1859-1fe8-4a2a-85f4-777662e3bd1e", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "5049a217-65b0-4b6b-8bfc-f08072eb5d3a", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-10-14T01:49:46.202235+00:00", "db_currency_id": "47d4dd1f-5da5-4c1c-8951-2f7cb2ae565f", "db_currency_code": "sample string 10" }, "company_type_id": "f784f748-244d-49a5-89ac-3a13d39bb37a", "company_type_name": "sample string 32", "company_type": { "id": "8003581b-8a90-459e-8fff-d030ff63242e", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "d2fa7634-9d2f-4f4b-a9ad-3a26bc68c4ed", "sales_organization_code": "sample string 5" }, "db_language_id": "38b44f82-aea6-43e2-9838-6e9db3732925", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "22a32b28-20f9-4211-aef7-63c0bbcd2a1f", "article_price_label_code": "sample string 37", "db_payment_method_id": "17da81e1-51b9-47f6-91e7-d7561e96338c", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "62f3ff63-e6ca-4121-b8e1-37b2991921a2", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-10-14T01:49:46.202235+00:00" }, "company_sector_id": "0843ff37-01dd-440a-bbc7-0a6544e21399", "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": "478eb0bc-7204-4197-97b9-d83150b04364", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "98145285-cb66-4bd5-82be-e6759315cb76", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "65260a32-e085-454b-b148-77684ce34320", "account_manager_user_code": "sample string 56", "company_status_id": "de7e626d-e6aa-4bfe-8fee-fab31f00df4c", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-10-14T01:49:46.202235+00:00", "id2": 60 }, "db_language_id": "59326d49-2db9-43b7-8900-ebe357c31791", "db_language_code": "sample string 7", "db_title_id": "69f9ee17-67c6-44eb-ab22-aaff6a2bb9b9", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-10-14T01:49:46.202235+00:00", "create_date": "2025-10-14T01:49:46.202235+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-10-14T01:49:46.202235+00:00" }