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": "ce39de8f-19d6-44d0-81bb-be9babdd4e8c", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "5c200f97-6dd8-45ff-aae5-7884f3a05917", "company_code": "sample string 5", "company": { "id": "1377f264-5aa2-4b1b-b7bd-05925cdca853", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-04-24T11:32:09.1931269+00:00", "sales_territory_id": "dfae70a2-6e64-421f-869f-982bc478d03c", "sales_territory_code": "sample string 9", "sales_territory": { "id": "6ac993fa-f674-4884-a548-ed9792de5a87", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "c64b3991-694e-4ff4-b255-9fc196fa4bcc", "sales_organization_code": "sample string 5", "sales_organization": { "id": "da97def6-4b3b-4b81-85b8-77f548ffc93b", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "2cc187ef-1910-4af0-b4c9-6ea336cf3843", "db_currency_id": "20462f1a-9e1d-4b32-8e25-b23f4c9428da", "db_language_id": "c31fa4d5-3189-45cc-88c9-6fd8561d9a4a", "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-04-24T11:32:09.1931269+00:00" }, "modified_dateutc": "2024-04-24T11:32:09.1931269+00:00" }, "marketing_segment_id": "d11057e1-0c3d-4f57-b373-eb76416de5e6", "marketing_segment_code": "sample string 11", "sales_organization_id": "ea1329e4-3afb-42c8-94cf-20d99d090a84", "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": "80a9a940-293c-4d0c-9608-03eb8b349864", "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": "f802339c-e9d3-42a1-94fb-71e732d9d430", "db_country_code": "sample string 28", "feelist_id": "72de5143-28a8-4a26-b788-021be50d3d54", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "160e53b9-17fa-4816-9db1-d0cf6ca3a9cd", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "53f7ef9e-0e6c-46ad-a5de-ec31a2656b48", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-04-24T11:32:09.1931269+00:00", "db_currency_id": "efbcb7aa-25ea-46a3-9e03-897b440e889e", "db_currency_code": "sample string 10" }, "company_type_id": "b58054c6-23f4-480d-9d72-f8d348383c8e", "company_type_name": "sample string 32", "company_type": { "id": "fe04471d-c489-4431-9106-cb6a1a7debc2", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "eed40b46-7532-4da0-8c40-af6d63e4f84f", "sales_organization_code": "sample string 5" }, "db_language_id": "4eedc359-76f5-4caf-beee-311fd23d0e0f", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "982728e6-7bdb-4409-8f32-18a244b83edc", "article_price_label_code": "sample string 37", "db_payment_method_id": "cf0a3e70-996c-4ae7-a4d5-748543a255a0", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "0439f841-7cd3-48b3-bd53-ba4de0e97472", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-04-24T11:32:09.1931269+00:00" }, "company_sector_id": "0a72cc4c-f960-42b3-9483-033afc26ca11", "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": "fce55ab2-7130-46ae-bae4-24caaa77e70d", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "256389ff-bd85-40a7-8429-e10fea93d187", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "9fe2db2c-224b-482f-9e83-791b07374d98", "account_manager_user_code": "sample string 56", "company_status_id": "746321af-d197-4798-ab8e-7785baf83d8f", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-04-24T11:32:09.1931269+00:00", "id2": 60 }, "db_language_id": "2328df98-4213-4b02-b2df-c78b4fb055e8", "db_language_code": "sample string 7", "db_title_id": "7babbc27-ffe1-4b75-9e6c-096859677378", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-04-24T11:32:09.1931269+00:00", "create_date": "2024-04-24T11:32:09.2087535+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-04-24T11:32:09.2087535+00:00" }