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": "5f2a8a8e-78bd-4c88-9699-135348a033cc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c6d72128-e95a-40ff-8c0c-ce96f124e83d",
"company_code": "sample string 5",
"company": {
"id": "1d7d2d98-89f5-4f85-b22b-a425be49f4de",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-29T13:48:31.8882814+00:00",
"sales_territory_id": "66a2c6b6-80ac-4b99-a938-9780d99d6d47",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b19e7d80-e9e1-44a7-ae26-0013b6b52b30",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fe07c6d-536c-45b0-8885-365fc8f46d5a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cb8c8961-4f18-47b0-bedc-00469b384151",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3866975b-72cc-42c2-b756-457ecf9660b1",
"db_currency_id": "e5ba7da5-78e8-4a0d-8607-36875c179612",
"db_language_id": "39bdcdc7-20f2-4ed8-bf9c-76f7c1494581",
"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-01-29T13:48:31.8882814+00:00"
},
"modified_dateutc": "2026-01-29T13:48:31.8882814+00:00"
},
"marketing_segment_id": "8ab16adc-130f-4eed-b743-a2e2a96c7262",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ae709e38-cae2-48bb-b1c4-94ceb40fd7a3",
"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": "84af96d5-8d66-4021-be21-4ffc570db214",
"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": "0d0adc1d-18e4-41bb-b4e7-7d01654f5197",
"db_country_code": "sample string 28",
"feelist_id": "037c74af-2b59-4295-8329-19c8e190fb99",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f6d58844-1588-49bb-aa29-dee60f4f6407",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a655bb66-b910-4a6a-8a49-2029648a2093",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-29T13:48:31.8882814+00:00",
"db_currency_id": "84be5787-e1e6-4ae0-9166-f302a9dc6123",
"db_currency_code": "sample string 10"
},
"company_type_id": "73a23e32-9994-4d9f-b919-06d4ca6c282b",
"company_type_name": "sample string 32",
"company_type": {
"id": "4acd3ed5-1c65-4a3a-a903-3c3ea7a38086",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd9bee39-bfd0-41ad-b357-f407543b5494",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7aeb21ee-d37b-4807-ac53-131ff21b31c8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bc6d1db4-54a4-4a8a-b243-3d3929a9673d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0399dba1-ca7f-4393-9317-b8bed6c42cf1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eabd6650-8135-4458-bb41-e6549c720dfc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-29T13:48:31.8882814+00:00"
},
"company_sector_id": "4124cbda-c761-4d32-9342-14756b4308d7",
"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": "c780fe0d-56af-43e7-ba76-665247dd669d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "204c10c0-2a15-407c-b674-b6ea566d8a4a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "59dada82-803e-49a3-a186-a6de11112352",
"account_manager_user_code": "sample string 56",
"company_status_id": "a1d99420-a9a1-46ad-a7e8-0f3642863fd0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-29T13:48:31.8882814+00:00",
"id2": 60
},
"db_language_id": "62bfc6aa-9472-44a8-809a-686539314315",
"db_language_code": "sample string 7",
"db_title_id": "49da6893-b4a2-41f4-bed7-326bacddc897",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-29T13:48:31.8882814+00:00",
"create_date": "2026-01-29T13:48:31.8882814+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-01-29T13:48:31.8882814+00:00"
}