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": "f2f6e7eb-4f52-4347-96b4-5ab7e382974c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b1cb41c3-8443-4a22-ba9c-9d87a5fcc167",
"company_code": "sample string 5",
"company": {
"id": "abdb3f03-dae4-454e-8740-8c293ba4aa3a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-20T14:31:48.282832+00:00",
"sales_territory_id": "00a3fcb4-8438-4d30-808e-55a08da9c809",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3eaea7e2-a0a5-4663-8382-6061b4ce0f60",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "75a057e8-6e90-43ea-8425-efefe141cc1a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "994e1931-cf35-4d79-9ca3-d8fceeaaf002",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58b9ae8f-c95c-486c-bb37-59f25b23b5df",
"db_currency_id": "cb89aaf0-fee4-4f31-9307-76f608fbae5d",
"db_language_id": "b9d5f947-4fed-4813-8f96-b1af97dbda7e",
"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": "2025-10-20T14:31:48.282832+00:00"
},
"modified_dateutc": "2025-10-20T14:31:48.282832+00:00"
},
"marketing_segment_id": "10661506-42b4-4c6b-83b8-c892de47e821",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4bb4e22a-2f32-415f-987b-b4d4e64c4839",
"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": "aceb3d54-50a6-47f4-ae28-e1b050cef8e3",
"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": "057f697c-8e16-40c3-a0f9-6f5affc04c01",
"db_country_code": "sample string 28",
"feelist_id": "fb91ef49-3cc1-46df-bc54-c6f04716674b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b59e79e8-2f74-4bc9-aea9-ece0c80d1548",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "704108cc-3b7b-420a-8f4e-ee3e60391829",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-20T14:31:48.282832+00:00",
"db_currency_id": "3734e212-a2a9-414d-aae7-4465ee2f299f",
"db_currency_code": "sample string 10"
},
"company_type_id": "49c7458f-a5e0-4869-92c1-b2d6cc0a1367",
"company_type_name": "sample string 32",
"company_type": {
"id": "1fe6a6dc-fb8c-4e82-9c43-dcd8393b1cce",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7113ddab-18b2-4719-aa84-ed5c2f4a0752",
"sales_organization_code": "sample string 5"
},
"db_language_id": "694f72fc-4eee-49b8-827e-e52923fc1b44",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6ed047ba-e336-4513-a828-dd68adc70735",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1ece5a20-df08-426e-a073-e1805cf1a0be",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "92e41b4d-99a3-4ffc-ab46-61595d4a97c5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-20T14:31:48.282832+00:00"
},
"company_sector_id": "e62d0395-f7d0-4ae0-b5f8-b4381edd8880",
"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": "4299d35a-559b-485c-b22e-c2d624290e5d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7252a5fa-a7db-440c-a2e2-6a7e42c26ae8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f9cec38f-46fb-4e48-aa99-3718b4cdf3fe",
"account_manager_user_code": "sample string 56",
"company_status_id": "adf3a12f-a74a-4ee5-97e2-27fcf0d12b9c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-20T14:31:48.282832+00:00",
"id2": 60
},
"db_language_id": "c6a85211-9213-42fe-aa98-2a004d6040e9",
"db_language_code": "sample string 7",
"db_title_id": "46351903-541e-4764-b7b1-e2767358ff22",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-20T14:31:48.282832+00:00",
"create_date": "2025-10-20T14:31:48.282832+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": "2025-10-20T14:31:48.282832+00:00"
}