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": "593b68e9-07b8-4de3-b483-9ac9b158d97b", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "55da9fec-b4b6-4fdb-9637-06700d74157f", "company_code": "sample string 5", "company": { "id": "387d37ff-7e7c-4c4c-8737-5673a0d324ec", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-18T02:53:57.8965947+00:00", "sales_territory_id": "208d5855-9fb2-4e23-9627-14efda7634a3", "sales_territory_code": "sample string 9", "sales_territory": { "id": "8a76b94d-1e6a-4b41-9322-42e605d94710", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "56f1096a-69b9-473b-bbb8-3dc523eccd89", "sales_organization_code": "sample string 5", "sales_organization": { "id": "1bacb2f3-51a5-4c09-addb-f68432802835", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "a58baea9-8d1e-45f3-8527-876cb0973408", "db_currency_id": "5279921a-1aa2-4a4c-97eb-4b636b8541e0", "db_language_id": "f332e880-8a45-4e87-87da-54977fab065c", "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-07-18T02:53:57.8965947+00:00" }, "modified_dateutc": "2025-07-18T02:53:57.8965947+00:00" }, "marketing_segment_id": "3c92c33e-10d4-4d1a-9478-66a1dafbf151", "marketing_segment_code": "sample string 11", "sales_organization_id": "a9b2314e-a0c5-4107-8d16-4d76efb0034f", "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": "e287c8c2-dd71-421e-b964-210b638652bd", "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": "9b5ba33c-9e7a-4b00-83d3-378fffad6148", "db_country_code": "sample string 28", "feelist_id": "dea8d286-cdf0-4642-aaa1-3032707a91c6", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "d1dc570b-5509-4d94-83a1-0d5258a71c29", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "73681885-c586-4019-b60b-a2f73699926b", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-18T02:53:57.8965947+00:00", "db_currency_id": "03ba0d3b-028a-4799-80c9-85ed261d2cb0", "db_currency_code": "sample string 10" }, "company_type_id": "e72215f0-aafa-4312-a5b3-2c0c988c4fc5", "company_type_name": "sample string 32", "company_type": { "id": "4401b7a8-05bb-417b-a1fc-abb71d5a5aea", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "3f05b910-e326-486e-9001-32f61b4dfd58", "sales_organization_code": "sample string 5" }, "db_language_id": "f217a8dd-699a-4b11-aab8-21a0c9a23949", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "8d86ece1-c867-4858-91c3-641f6b374f52", "article_price_label_code": "sample string 37", "db_payment_method_id": "269aa223-b6bd-408a-a50e-681097628a68", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "32a24934-dec0-42d6-9594-fa2ef3d14982", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-18T02:53:57.8965947+00:00" }, "company_sector_id": "c184bc50-6114-4b5f-ab24-35974ba4fadc", "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": "24f42e12-c7d9-42c9-9df0-886ebb878f8b", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "98c2efe4-9e10-40da-b5be-e9caa4ef7c8d", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "a1b95c61-6983-42fa-83f9-de419c96bf7f", "account_manager_user_code": "sample string 56", "company_status_id": "9812daef-f75a-4dff-9636-98b38756748d", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-18T02:53:57.8965947+00:00", "id2": 60 }, "db_language_id": "a8a785cd-8a46-441d-9bfe-a893e823888b", "db_language_code": "sample string 7", "db_title_id": "0f474425-2305-4604-a645-0d4d4f686f2c", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-18T02:53:57.8965947+00:00", "create_date": "2025-07-18T02:53:57.8965947+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-07-18T02:53:57.8965947+00:00" }