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 :
contact| Name | 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
Sample:
{
"id": "0f0b459f-2d3d-4dbe-80b7-af620d339e7f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3d8fd18a-daca-4a91-ac72-bb01ec761d29",
"company_code": "sample string 5",
"company": {
"id": "ccb7c8ef-c049-4822-a9bf-d1c92b2b0d7c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2022-12-02T21:45:53.5470091+01:00",
"sales_territory_id": "d4a04151-43a3-4fee-8f74-0b5189bdc238",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cb05390d-2782-44b7-bbc3-1a691b7132cb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e53e404-a58e-42a1-83b5-9aa68799d24e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24350e00-d345-4882-bf0c-4e8cdab113c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "209ec3ec-9470-4153-8c2e-019669ab373c",
"db_currency_id": "7456add1-2c90-47f1-9ef2-e58411e1b969",
"db_language_id": "6a68a932-3a55-4ec2-bbb7-a7b7bd15951b",
"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": "2022-12-02T21:45:53.5470091+01:00"
},
"modified_dateutc": "2022-12-02T21:45:53.5470091+01:00"
},
"marketing_segment_id": "476ca7ed-5019-453c-ad31-adb299649c5d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "54662b79-22a5-45f9-9851-f828df6b175a",
"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": "19b572af-5f2b-4fd2-aad8-23bda28c0c4e",
"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": "bd39c0fe-128f-4eec-9c68-af749d0e608d",
"db_country_code": "sample string 28",
"feelist_id": "9cc36a15-9fe0-4249-a6c4-a4e977dbb95a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "01cb440c-631d-437e-85ac-566abb97962a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0d187902-22a9-44f3-b913-4c2c44159a48",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2022-12-02T21:45:53.5470091+01:00"
},
"company_type_id": "472058b3-5004-44fa-ad90-3a1378320950",
"company_type_name": "sample string 32",
"company_type": {
"id": "2ef43168-361f-4183-89fb-1a610f26630b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8480d16b-afd5-4d8b-883c-bb44e53dcfd6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cbc58e55-f036-43d1-8730-355e36db4dd5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "917b01b1-eb4d-4953-9d36-93b44848b581",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "93489070-3217-4357-ad4f-a8c0e3e28d8c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ddcbb080-d626-46c7-a37e-da9574f58632",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2022-12-02T21:45:53.5470091+01:00"
},
"company_sector_id": "22dfc545-00d7-44d6-969b-d2cb8c342c77",
"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": "175c7367-0b11-4693-a866-d5eee2d42cb0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "866f3cd2-f641-4f0e-8817-c294ef6af6f9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0863df7e-7bac-4cc2-b09c-30e4a672fb77",
"account_manager_user_code": "sample string 56",
"company_status_id": "f911ed05-5b3f-44db-88ca-c39c0b7216d3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2022-12-02T21:45:53.5470091+01:00",
"id2": 60
},
"db_language_id": "06c65e67-003c-45b8-af5a-f68c3ffb7190",
"db_language_code": "sample string 7",
"db_title_id": "5eea3f78-d04d-46e6-9a82-4823a5228504",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2022-12-02T21:45:53.5470091+01:00",
"create_date": "2022-12-02T21:45:53.5470091+01: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": "2022-12-02T21:45:53.5470091+01:00"
}