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": "cb381d5c-7095-48ed-9ab3-aab81295d65a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1d5b265c-f2f9-4737-be8b-a8d180bc6fe9",
"company_code": "sample string 5",
"company": {
"id": "a9b3a51d-f33e-4193-8a52-ce55eb7f38e7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-19T17:05:20.3488218+00:00",
"sales_territory_id": "fc95c2f3-c71b-4b18-9d1e-99a9563105fa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d38f979e-6195-4f3a-b577-629c00802f03",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "12d0ea65-84df-4566-b840-b13cb213208c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8d8ccc59-0399-4d82-aaa2-735df85599fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4297eb6b-3e61-423e-a3f1-77f8d05b284d",
"db_currency_id": "44cfa563-867e-4460-ad9b-7e2145f37df9",
"db_language_id": "721ebbed-3829-4032-afe7-40f3f24f22ca",
"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-19T17:05:20.3488218+00:00"
},
"modified_dateutc": "2026-09-19T17:05:20.3488218+00:00"
},
"marketing_segment_id": "4a88f427-6c9c-4024-ae7b-d1a7ed8dbaf2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "334921a2-5fb9-49b2-b9f7-63e8e143b948",
"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": "abde9d7a-0323-45b3-817c-53276bc73091",
"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": "5aff1a69-f081-4c8c-9404-d84e80fd2953",
"db_country_code": "sample string 28",
"feelist_id": "cf7f649f-5d8a-4458-92e7-20d83c0633d4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d957aa4c-3f5a-44cb-9e07-3f8414971e18",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e2bb7a7c-731f-491c-af41-94a52a2ed490",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-19T17:05:20.3488218+00:00",
"db_currency_id": "678a47c2-fbce-45f5-ad50-bba135f10c19",
"db_currency_code": "sample string 10"
},
"company_type_id": "61231e83-fbad-4572-a87c-3d0bfbf60c4a",
"company_type_name": "sample string 32",
"company_type": {
"id": "599a0736-6009-4ec6-95cb-ce1a3afe6aa8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4a2cb826-3e2f-4c4e-863e-066050748f51",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ee4abe02-d620-4db0-8ead-3bf10b347abf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1e6bc197-b37f-40b7-9143-1626dc8ad08f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0a2e1ca4-a86a-406d-b495-101bd61bfbf1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "40e1748c-feb1-40d0-b7a5-6de32281382c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-19T17:05:20.3488218+00:00"
},
"company_sector_id": "044a1580-bc84-4d9e-b00c-858330f3d662",
"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": "8d80a918-b68f-4d08-87d0-fbb3fdaaa504",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b64c89a0-70f9-4d6e-9b9c-1d11005a2673",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4347f3c-c605-48e4-96f5-1b817195469d",
"account_manager_user_code": "sample string 56",
"company_status_id": "0982aa81-fb3f-4fcd-84d0-b71ebf94445f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-19T17:05:20.3488218+00:00",
"id2": 60
},
"db_language_id": "ab846865-1a2d-446d-807c-67cc1e0eb203",
"db_language_code": "sample string 7",
"db_title_id": "2cb3736c-9033-454a-8985-883f58cf1eb5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-19T17:05:20.3488218+00:00",
"create_date": "2026-09-19T17:05:20.3488218+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-19T17:05:20.3488218+00:00"
}