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": "e9e82389-37ff-4196-9c99-28496287d859", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "07ed401c-a68b-4df9-9918-fe5b4eec5117", "company_code": "sample string 5", "company": { "id": "972659db-866f-4300-a8d4-977ea3cc5eeb", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2024-03-27T08:13:05.5704099+00:00", "sales_territory_id": "c33ace1a-5ee6-447f-8cc8-1aaa78207d4c", "sales_territory_code": "sample string 9", "sales_territory": { "id": "1a098ade-98e5-45ed-9530-53b1136ec3dd", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "0af50d0a-0815-4101-bd53-c6500ef4317c", "sales_organization_code": "sample string 5", "sales_organization": { "id": "cc3e05b2-2aae-4db5-bbb6-22502ff23734", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "4b3992c6-2dc1-45e2-8344-21653afd78b8", "db_currency_id": "611c0df8-5c2d-4fe7-97d3-d8aaa023fc81", "db_language_id": "1da15bd7-d88c-4aee-9d6a-a0e8e7daaf14", "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-03-27T08:13:05.5704099+00:00" }, "modified_dateutc": "2024-03-27T08:13:05.5704099+00:00" }, "marketing_segment_id": "cec8334e-e056-4740-9f8d-2b999bbb7629", "marketing_segment_code": "sample string 11", "sales_organization_id": "5413ac7b-9112-4d7c-868d-30b81db1061b", "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": "68f4a558-cf4b-4ebe-a5f3-7c826b04ef7c", "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": "1bd0656b-b91b-44c0-96d9-ac67a4ef032c", "db_country_code": "sample string 28", "feelist_id": "14c9eb7b-98c5-4ab0-b4a1-89bb6c6cc524", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "05ee0659-1bb6-49f7-9ee6-ae746d8036ac", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "a5018bff-d4b4-4321-8310-05e5d339c917", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2024-03-27T08:13:05.5704099+00:00", "db_currency_id": "1bd4b3ce-5c36-4f63-b5b1-83aee8411621", "db_currency_code": "sample string 10" }, "company_type_id": "d2148adb-2814-4c1c-b93d-48dbb0afa5bf", "company_type_name": "sample string 32", "company_type": { "id": "7cecdbb9-dd72-4078-aa66-f3d66f33cd65", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "5a004c0b-92e4-43bf-92b0-f0e9c0b2f56c", "sales_organization_code": "sample string 5" }, "db_language_id": "325bf4cd-6e78-4fc7-8ecb-a433bb8be1b0", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "d04c92a0-ca19-4155-b894-6232d0c47140", "article_price_label_code": "sample string 37", "db_payment_method_id": "c9289817-ea16-468f-b394-b90b50c4c325", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "70e08a6f-08f5-4e34-b32b-1a4aa43b964b", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2024-03-27T08:13:05.5704099+00:00" }, "company_sector_id": "ac58e456-3187-4c4c-9479-f8fc8d8baada", "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": "86187fe3-af90-40b0-b21d-f1aeb7aefbf7", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "7de1e0ec-77d6-4c5a-8d1a-c579dd522a2e", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "2b51b5b1-d960-4977-bfd4-d855451a1f63", "account_manager_user_code": "sample string 56", "company_status_id": "d9e0f8d9-1c60-450e-9eb7-a33d4baafaf6", "invoice_email_to": "sample string 58", "modified_dateutc": "2024-03-27T08:13:05.5704099+00:00", "id2": 60 }, "db_language_id": "7647f53b-5aff-4a00-8e98-07aa4c1891db", "db_language_code": "sample string 7", "db_title_id": "c27f5f23-f0da-4468-bdae-48667c2d1837", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2024-03-27T08:13:05.5704099+00:00", "create_date": "2024-03-27T08:13:05.5704099+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-03-27T08:13:05.5704099+00:00" }