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": "0c5a1d49-a32d-4190-9365-27cb713cb7ec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ba2e73cf-3417-4fe5-824d-00d9d4a2e845",
"company_code": "sample string 5",
"company": {
"id": "3b7fbf95-5eef-43c5-9a6c-485c1533ecef",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-04T03:55:33.5265425+00:00",
"sales_territory_id": "66723f4a-854c-4273-9723-f7df68691cd3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "57879b87-f3c2-4bcd-bee2-b949610f71c9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8072a494-3615-436c-a51a-02ead2ee3b22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f864bbe4-3486-4bf7-b869-dff17bdeec46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "597d9d08-4397-450f-9898-bd1670e10def",
"db_currency_id": "2e2807e3-62cd-44e1-bc34-717934e443b4",
"db_language_id": "27fa61ef-118b-43ab-a461-7007d4408cb7",
"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-09-04T03:55:33.5265425+00:00"
},
"modified_dateutc": "2026-09-04T03:55:33.5265425+00:00"
},
"marketing_segment_id": "7e0a0f24-94c1-4145-8925-ddb97547e13d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "13f0a9ae-d077-4de1-922f-c44ca5935c41",
"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": "ea45e145-6a10-413e-9650-255695659111",
"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": "9b712247-f585-496c-b398-aeff0b1213be",
"db_country_code": "sample string 28",
"feelist_id": "ab630dcc-5bb7-4a4b-98d9-b9a483554061",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cc39e37d-1fac-4f25-9cd0-e4d5e8ac0c71",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9bfd1c0f-aaac-42e1-a869-47bab98060bd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-04T03:55:33.5265425+00:00",
"db_currency_id": "88844faa-ec7e-41af-b5fa-762ab6cd22f4",
"db_currency_code": "sample string 10"
},
"company_type_id": "1263fdff-0e1c-4ec0-9b41-b7094f9764ad",
"company_type_name": "sample string 32",
"company_type": {
"id": "bcb1ddfc-5d77-429a-8862-5a543a780423",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74b3f8d4-89ce-4342-b33c-260903fcf9f2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f96e9213-7e63-4db5-9af2-749fb655638c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "737412ec-2c17-48f4-8ae4-fb137672c897",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c50f9fe4-062c-459b-a7d0-cd82e7be5fdd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9106b8a5-aeb1-4727-97ef-e0fa4edb5d67",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-04T03:55:33.5265425+00:00"
},
"company_sector_id": "49d56c60-0db3-4312-a8e4-2b482e924e7a",
"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": "155bf75e-e07f-4d4b-a83c-9623b15f0f94",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9a70cb16-6337-4130-9012-02af83bc72b0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f82efea9-83da-4e14-b886-944bc67faed8",
"account_manager_user_code": "sample string 56",
"company_status_id": "08c130c9-096e-4a6f-a2e4-21879be1c517",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-04T03:55:33.5265425+00:00",
"id2": 60
},
"db_language_id": "aecd9af4-f30f-4367-844a-bfd6644dd6e3",
"db_language_code": "sample string 7",
"db_title_id": "12606ea6-4bbf-4055-b8d9-9e12664e445c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-04T03:55:33.5265425+00:00",
"create_date": "2026-09-04T03:55:33.5265425+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-09-04T03:55:33.5265425+00:00"
}