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": "0e5b5da8-60cf-4430-bfbd-2a556500c4e2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "af1881b9-5d7b-40d4-bca9-73418557dba7",
"company_code": "sample string 5",
"company": {
"id": "6839dfca-96b3-4140-947f-c8a1e5d84e30",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-30T12:28:21.1096811+00:00",
"sales_territory_id": "cab1ec12-1fb3-4ec8-8e43-787d5cc719a6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "22770294-c123-448c-908d-64628b41c0b6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed091ed2-9749-4dfd-8e71-4f3d1ddd664b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cb9bb50f-2dcd-4161-87e5-1b9e9891698d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8763afd8-a1c7-48b5-a5bc-cb3648326b47",
"db_currency_id": "25ee18c2-40fb-43cf-9d1d-ea76f0355340",
"db_language_id": "068e892c-4435-4e5e-8d20-5fdb101208f4",
"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-30T12:28:21.1266812+00:00"
},
"modified_dateutc": "2026-09-30T12:28:21.1266812+00:00"
},
"marketing_segment_id": "48859e38-d893-420e-878f-1149df7b81ab",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3f1b4d04-813e-4c0d-805b-ec09594f0255",
"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": "cd582cf8-41c9-4213-9d46-5546874aa69b",
"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": "060e49a9-47b3-4def-a5f1-455a13e2c445",
"db_country_code": "sample string 28",
"feelist_id": "9b1b978b-d99c-4a26-b42f-db4c7d616623",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3f14cc3f-61b2-4ca9-9f1e-5b08b7832020",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "84280b58-8281-4d05-8d5d-70cb9d52063c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-30T12:28:21.1266812+00:00",
"db_currency_id": "467c17ff-b6d9-4d2e-8153-892363d484d2",
"db_currency_code": "sample string 10"
},
"company_type_id": "44b1f616-8839-47ba-984d-a31b01ffb499",
"company_type_name": "sample string 32",
"company_type": {
"id": "cb2d2f44-9c48-4ff3-93cd-7ac4b108ab1f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7e590ee-41d2-4d9c-b437-9c33c201d186",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2d7a548c-d30c-4e5d-b12a-fa2aec1568ce",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fe5a4131-21c6-42bd-b241-4d3afea13bcc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1efb3961-dbed-44ef-9ea9-f481b3a526cc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1cfc135d-1bae-4013-8280-cf5d6292ac53",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-30T12:28:21.1266812+00:00"
},
"company_sector_id": "e819bde8-9b8c-4c39-80d2-69dd0cc26921",
"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": "c698a356-f8d6-4ffa-8213-636b73eb12f0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8abef511-6504-4323-bb85-294f0cb5cfd4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ef9f534e-19fe-4b44-ac2f-a7c6f214c379",
"account_manager_user_code": "sample string 56",
"company_status_id": "d3720469-a07f-4d40-a219-1068a59b3d6e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-30T12:28:21.1266812+00:00",
"id2": 60
},
"db_language_id": "d7ae8f20-1c79-4d4d-a355-9a5c7051b353",
"db_language_code": "sample string 7",
"db_title_id": "f639ebfb-864c-473b-850e-0c60becfdf24",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-30T12:28:21.1266812+00:00",
"create_date": "2026-09-30T12:28:21.1266812+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-30T12:28:21.1266812+00:00"
}