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": "0f4787ba-0957-430a-bc51-aeb0529ff190",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "55a50c69-91f4-46b0-8e4f-632c00677b91",
"company_code": "sample string 5",
"company": {
"id": "9931554a-bceb-4db2-8d97-82cf1761687a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-24T02:24:48.7183893+00:00",
"sales_territory_id": "083e8745-ef29-47f9-ae1c-2d99c27bd288",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7dfed738-f19c-4fdb-b471-28c6224e7641",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9d8607f-791d-45cc-aff8-25c2b84aa5f7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e0cae9fa-b227-4b32-8043-67382e61e981",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "072e021d-03b2-44c8-944e-1469ce2ba38d",
"db_currency_id": "1c93875d-8b7d-4108-9d9d-a2f9c4530299",
"db_language_id": "60132774-6b81-405e-b09f-338eb186a0fd",
"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-08-24T02:24:48.7183893+00:00"
},
"modified_dateutc": "2026-08-24T02:24:48.7183893+00:00"
},
"marketing_segment_id": "643ae6a3-28c9-4d31-883a-1d003d047069",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff49f46c-dbf0-4e25-869c-919f1c13fe1d",
"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": "a208e3d6-2040-4952-9231-425049e3c396",
"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": "74e899f8-1f29-4a4d-bb97-b16ef7018970",
"db_country_code": "sample string 28",
"feelist_id": "1038c388-cf65-4da2-849c-979fd7c4a83f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2757dd33-785d-43c4-82cc-875ebdcd8644",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "745818cf-9d22-4eca-bad9-87ad9c0aa8f9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-24T02:24:48.7183893+00:00",
"db_currency_id": "d90696a8-d874-4684-914f-a0ce817dc027",
"db_currency_code": "sample string 10"
},
"company_type_id": "598467bc-1688-444d-944c-a952bf6a1847",
"company_type_name": "sample string 32",
"company_type": {
"id": "6c3c1764-c41a-4790-be76-49dea25f9d77",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "84475d74-dc08-49d4-8d16-a091998317b4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e4944a06-5d1a-49b0-a987-314f0e957963",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "66850c76-2d8d-4803-88b5-6ddb246dd79d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1979b90b-ac32-449e-9e17-dd03a751d16f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "81a53364-bd53-4e6c-b2b1-49000d3802a3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-24T02:24:48.7183893+00:00"
},
"company_sector_id": "495af98c-1e8f-4a85-a456-d9317bafb7c2",
"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": "86231d37-74df-4c7c-be7d-6314afcadff1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f309105b-1663-4443-aaaa-88ee400cc5ee",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "18808e7c-d3a7-4d8f-9ad5-275535342ac7",
"account_manager_user_code": "sample string 56",
"company_status_id": "b87ccfae-5901-4fa1-9060-5a6d49f09473",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-24T02:24:48.7183893+00:00",
"id2": 60
},
"db_language_id": "ed381cac-8053-4a5b-9cea-c4031e026daa",
"db_language_code": "sample string 7",
"db_title_id": "90dbf188-d913-4a1a-83cc-7779d4c5f0c3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-24T02:24:48.7183893+00:00",
"create_date": "2026-08-24T02:24:48.7183893+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-08-24T02:24:48.7183893+00:00"
}