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": "02da654a-6b5d-4717-9d66-d7b2ff01cba7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7c169f77-e6f5-4dfe-87a3-60a367a382a1",
"company_code": "sample string 5",
"company": {
"id": "89719a7d-b795-446a-91f7-87d6d6360199",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-05T20:53:46.6858941+00:00",
"sales_territory_id": "dedd7f6a-ef46-486b-aefc-3dc0b34f9ff6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f521bda8-be8b-4677-bcac-27c3140bc19b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8eb4dac-4027-4c78-97ce-16b0c51d84b7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0cdb4ca7-1739-4db7-9dc3-d72875041935",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b4782bf-5679-4ca6-aa2c-f84009cfc8dd",
"db_currency_id": "9ca3bcd9-2d0f-4117-9166-052e1d618645",
"db_language_id": "4ef323eb-a1a8-4d25-ab3e-674bd03c6d8e",
"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-05T20:53:46.6977954+00:00"
},
"modified_dateutc": "2026-10-05T20:53:46.6977954+00:00"
},
"marketing_segment_id": "fcdef1d1-c2f8-42ff-82f3-b740beeb639e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7965fb44-6885-421c-98a5-ac208e2225c0",
"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": "029d11c8-f0bf-4129-9e4c-ec964738002f",
"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": "1fe173cc-7bce-4b61-85b6-c92eb78c1289",
"db_country_code": "sample string 28",
"feelist_id": "8cf9d604-dfa4-4a8d-8fe2-c6af73f35d1b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9d1d1502-b5d9-467e-aefd-0aa8754e06a0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5b3013cd-2103-4563-b9b5-bfb7678a3ed6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-05T20:53:46.7156411+00:00",
"db_currency_id": "1b837eaf-d009-430d-bce3-59067e9760db",
"db_currency_code": "sample string 10"
},
"company_type_id": "813e8fdc-3a9b-4f3a-9f2f-0a5914a870fa",
"company_type_name": "sample string 32",
"company_type": {
"id": "724eba64-477d-4d30-9db4-0cf328a70d25",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "07a518c9-a208-45b1-afe3-5aacedc8f83e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b88c1d92-97b5-40ad-93eb-985530de03e7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4cfbf679-1719-44be-8960-44c07a11f1f1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d8eb76ea-d5c7-403a-99fb-a9b3e77bb595",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1af3aa7d-b125-4ec7-8e4a-2f0ece0ac851",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-05T20:53:46.7156411+00:00"
},
"company_sector_id": "ee608faa-cfe1-4e2d-8be5-6d0288bafce0",
"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": "f30a85c7-53b6-4e32-b4bc-ad3713602d78",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "06908dcf-0418-4749-a186-4f7c67c3e751",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d542b691-1ea0-466f-a638-ff7db9216a88",
"account_manager_user_code": "sample string 56",
"company_status_id": "109747f9-b398-4ed1-b7ac-b6ed7a6f443c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-05T20:53:46.7156411+00:00",
"id2": 60
},
"db_language_id": "1cc9b10b-4b73-493d-abef-b12de961bc05",
"db_language_code": "sample string 7",
"db_title_id": "b0a83525-33e7-4a33-9347-b2b90e64f9ed",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-05T20:53:46.7156411+00:00",
"create_date": "2026-10-05T20:53:46.7156411+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-05T20:53:46.7156411+00:00"
}