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": "fdd92d9a-a6ae-42a3-ac3f-6e7189c0871b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3e52d852-eaa5-44e3-8a48-ed2b81cc66ba",
"company_code": "sample string 5",
"company": {
"id": "2c1fb626-cc29-4953-96d2-5ee5b2649f0b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"create_date": "2026-10-10T16:05:44.4323183+00:00",
"sales_territory_id": "6371c8de-d013-46bf-918a-ff9f7dca94e8",
"sales_territory_code": "sample string 8",
"sales_territory": {
"id": "913fd4e8-ea2a-4821-8f98-f25b52ac5564",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea1befcc-60f2-436b-ad89-c9ad6b557748",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "39bad522-6c5a-4919-b8c5-3ad137775e2e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e84387f-8021-4792-91b2-776906088dea",
"db_currency_id": "58f3b6c1-2b14-49e2-b453-95113e3f8a0d",
"db_language_id": "aa9209ad-57ab-49fe-ba0a-e0039cfe6f96",
"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-10-10T16:05:44.4323183+00:00"
},
"modified_dateutc": "2026-10-10T16:05:44.4323183+00:00"
},
"marketing_segment_id": "4ea1cd79-10e4-4bf0-a66b-4f095595e63c",
"marketing_segment_code": "sample string 10",
"sales_organization_id": "13c13354-e21e-4a01-b35a-493f81600b3d",
"sales_organization_code": "sample string 12",
"company_sales_status_code": "sample string 13",
"vat_reg_code": "sample string 14",
"is_working_address": true,
"parent_id": "c29314e5-3f7d-46ab-a8ad-0a29d68e492f",
"parent_company_code": "sample string 17",
"phone": "sample string 18",
"fax": "sample string 19",
"url": "sample string 20",
"email": "sample string 21",
"street": "sample string 22",
"street_number": "sample string 23",
"city": "sample string 24",
"zip": "sample string 25",
"db_country_id": "c7b6c4e4-045d-4e84-a96a-88724e35e8f9",
"db_country_code": "sample string 27",
"feelist_id": "36438cf0-2e6b-4478-a19f-50ecff7867a3",
"feelist_reference_back_office": "sample string 29",
"feelist": {
"id": "2509ca56-bbc5-4913-8de9-444906fe0271",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e921b9da-a265-43ab-ab14-421b12804825",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-10T16:05:44.4323183+00:00",
"db_currency_id": "5d7a8881-6a17-4404-9b75-18feb7128520",
"db_currency_code": "sample string 10"
},
"company_type_id": "843f6f51-9b2c-49db-83f4-adfcd92ceadd",
"company_type_name": "sample string 31",
"company_type": {
"id": "fad06ff5-c392-43e2-93af-4097842ffbbc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e6c2385b-f053-47cc-a596-4cad05593428",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6e538c2f-3d2e-48a4-b302-fab092bcf57a",
"db_language_code": "sample string 33",
"code": "sample string 34",
"article_price_label_id": "53c49127-d2b3-4894-b665-84c63032b961",
"article_price_label_code": "sample string 36",
"db_payment_method_id": "e737f393-e382-4dde-9e46-2efd129e768b",
"db_payment_method_reference_back_office": "sample string 38",
"db_payment_methods": {
"id": "894aec1e-d37e-4e4d-bdfc-6e3088c04fed",
"name": "sample string 2",
"pm": "sample string 3",
"description": "sample string 4",
"reference_back_office": "sample string 5",
"activated": true,
"modified_dateutc": "2026-10-10T16:05:44.4323183+00:00"
},
"company_sector_id": "fa85c130-5f42-4bf1-be7e-0b4c6d8dfa7e",
"company_sector_code": "sample string 40",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 43",
"bic_code": "sample string 44",
"specialities": "sample string 45",
"register_number": "sample string 46",
"register_city": "sample string 47",
"bankaccount": "sample string 48",
"mobile": "sample string 49",
"service_manager_user_id": "b5a655a8-2988-4bb2-b99f-67db64a64168",
"service_manager_user_code": "sample string 51",
"finance_manager_user_id": "cff9e471-6add-46fd-a3b6-7d789b27d64d",
"finance_manager_user_code": "sample string 53",
"account_manager_user_id": "276ae5d6-b67c-4cf2-b2f1-510270c2c3fb",
"account_manager_user_code": "sample string 55",
"company_status_id": "00ff66f2-7bef-469d-a687-837670df54e6",
"invoice_email_to": "sample string 57",
"modified_dateutc": "2026-10-10T16:05:44.4323183+00:00",
"id2": 59,
"po_number_required": true,
"invoice_contact_id": "146f1b86-108b-4b1c-b852-6f8b8a5666b5",
"due_monthend": true,
"payement_conditions": "sample string 63",
"udf1": "sample string 64",
"udf2": "sample string 65",
"udf3": "sample string 66",
"udf4": "sample string 67",
"udf5": "sample string 68",
"udf6": "sample string 69",
"udf7": "sample string 70",
"udf8": "sample string 71",
"udf9": "sample string 72",
"udf10": "sample string 73",
"udf11": "sample string 74",
"udf12": "sample string 75",
"udf13": "sample string 76",
"udf14": "sample string 77",
"udf15": "sample string 78",
"udf16": "sample string 79",
"udf17": "sample string 80",
"udf18": "sample string 81",
"udf19": "sample string 82",
"udf20": "sample string 83",
"udf21": "sample string 84",
"udf22": "sample string 85",
"udf23": "sample string 86",
"udf24": "sample string 87",
"udf25": "sample string 88",
"udf26": "sample string 89",
"udf27": "sample string 90",
"udf28": "sample string 91",
"udf29": "sample string 92",
"udf30": "sample string 93",
"udf31": "sample string 94",
"udf32": "sample string 95",
"udf33": "sample string 96",
"udf34": "sample string 97",
"udf35": "sample string 98",
"udf36": "sample string 99",
"udf37": "sample string 100",
"udf38": "sample string 101",
"udf39": "sample string 102",
"udf40": "sample string 103",
"udf41": "sample string 104",
"udf42": "sample string 105",
"udf43": "sample string 106",
"udf44": "sample string 107",
"udf45": "sample string 108",
"udf46": "sample string 109",
"udf47": "sample string 110",
"udf48": "sample string 111",
"udf49": "sample string 112",
"udf50": "sample string 113",
"udf51": "sample string 114",
"udf52": "sample string 115",
"udf53": "sample string 116",
"udf54": "sample string 117",
"udf55": "sample string 118",
"udf56": "sample string 119",
"udf57": "sample string 120",
"udf58": "sample string 121",
"udf59": "sample string 122",
"udf60": "sample string 123",
"udf61": "sample string 124",
"udf62": "sample string 125",
"udf63": "sample string 126",
"udf64": "sample string 127",
"udf65": "sample string 128",
"udf66": "sample string 129",
"udf67": "sample string 130",
"udf68": "sample string 131",
"udf69": "sample string 132",
"udf70": "sample string 133",
"udf71": "sample string 134",
"udf72": "sample string 135",
"udf73": "sample string 136",
"udf74": "sample string 137",
"udf75": "sample string 138",
"udf76": "sample string 139",
"udf77": "sample string 140",
"udf78": "sample string 141",
"udf79": "sample string 142",
"udf80": "sample string 143",
"udf81": "sample string 144",
"udf82": "sample string 145",
"udf83": "sample string 146",
"udf84": "sample string 147",
"udf85": "sample string 148",
"udf86": "sample string 149",
"udf87": "sample string 150",
"udf88": "sample string 151",
"udf89": "sample string 152",
"udf90": "sample string 153",
"udf91": "sample string 154",
"udf92": "sample string 155",
"udf93": "sample string 156",
"udf94": "sample string 157",
"udf95": "sample string 158",
"udf96": "sample string 159",
"udf97": "sample string 160",
"udf98": "sample string 161",
"udf99": "sample string 162",
"udf100": "sample string 163"
},
"db_language_id": "1b4dae81-9d9e-4311-8600-fdc06b00f2f1",
"db_language_code": "sample string 7",
"db_title_id": "761314f8-867f-49b2-aeaf-c16a44bc789f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-10T16:05:44.4323183+00:00",
"create_date": "2026-10-10T16:05:44.4323183+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-10-10T16:05:44.4323183+00:00"
}