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": "47d5ff45-6dff-409d-8a73-56f10462bc40",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "13bb2c9e-31f5-4d4b-a39e-60b3eea8cdb0",
"company_code": "sample string 5",
"company": {
"id": "212d162b-09b2-4fc5-9741-ab7cb7d0c13c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T04:58:09.050795+00:00",
"sales_territory_id": "e475f1e4-eef4-444c-ba74-ef8e0a1719f0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dd684888-71f7-4d5e-a4ed-f671d24ecfbc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "413f4ce3-b313-409b-9019-4e457178c3dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f273c6ad-b940-421a-92ec-f6f082a5ed61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6910bc3d-13ac-4097-a83d-34092a4ce5c1",
"db_currency_id": "147d5962-7d84-4aec-87eb-c9028a26fdfd",
"db_language_id": "07ee3961-7066-4f18-92b3-5a61fed16c8b",
"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": "2026-06-26T04:58:09.050795+00:00"
},
"modified_dateutc": "2026-06-26T04:58:09.050795+00:00"
},
"marketing_segment_id": "d4f66546-02f2-4ba2-a769-358065e35423",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "95e67276-6595-4e97-8607-fd8a82e0e3ff",
"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": "7fc19bc7-83c1-4ae6-b78d-da388a2ccdd0",
"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": "f1b97c60-39a5-4c57-a70a-2e76beabc245",
"db_country_code": "sample string 28",
"feelist_id": "f3c0df25-63a6-4577-a833-386129fd6a04",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c33b8283-be61-4f14-a60a-e1a62c2be496",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1936c4b1-356b-4014-83f2-e13d998b2539",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T04:58:09.050795+00:00",
"db_currency_id": "148d3282-3f9a-4ee7-adcf-55ae9aa2efa0",
"db_currency_code": "sample string 10"
},
"company_type_id": "92567540-32cc-4558-b5f5-779ee92f4eff",
"company_type_name": "sample string 32",
"company_type": {
"id": "7e8f088e-da12-46c6-879f-6089e72da798",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dfcf0889-a7e3-449b-b9ac-6d4c620579dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "64ea0cb4-1c68-4a5d-89d0-2fa3ed1dbdfd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "838f6604-678a-46e4-8102-df0323621c1a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fe3cb0dd-ad59-4824-9e4c-6b7f41bece5d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1b430069-b3fa-45b7-9516-26ba169cdc73",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T04:58:09.050795+00:00"
},
"company_sector_id": "a940eae7-7672-445e-b58b-72dfce49d84b",
"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": "4c8571a6-f17e-4a5c-b91a-44bb06940861",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "36c74aba-7344-474b-b3e3-84c99b596723",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "394ccaf1-95fe-4ff4-9190-35ca796d9be4",
"account_manager_user_code": "sample string 56",
"company_status_id": "eb3f9409-3391-43d5-84a8-e8c793881a58",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T04:58:09.050795+00:00",
"id2": 60
},
"db_language_id": "51badb85-254d-4b1f-95a1-da0f5bbb3712",
"db_language_code": "sample string 7",
"db_title_id": "cee67a54-b219-4d3e-b877-fb407a2e1180",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T04:58:09.050795+00:00",
"create_date": "2026-06-26T04:58:09.050795+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": "2026-06-26T04:58:09.050795+00:00"
}