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": "17220e04-3115-4771-8e47-04b1de777089",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d64d2f22-e288-485d-a18d-5597a9e0f555",
"company_code": "sample string 5",
"company": {
"id": "9deb3029-1a7a-4e3b-ba45-c16741fd6e7a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-28T20:00:15.8939143+00:00",
"sales_territory_id": "df8c830f-5f1f-49a2-919b-ad16436ebd81",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fac8cf10-83eb-4a5a-a173-bc8ffb3b3d06",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9fd91b56-0aa3-472c-b787-24b4c8ddafb9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d94deb11-e356-4fd8-97bc-da463c546d85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ea0b952-fa6b-46fb-8cfc-7fae32b6ec16",
"db_currency_id": "922f7b88-a8f6-4b40-a262-819d1f200f23",
"db_language_id": "c0ab835a-3e6f-4c52-b0e9-271b8c238c8e",
"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-05-28T20:00:15.8939143+00:00"
},
"modified_dateutc": "2026-05-28T20:00:15.8939143+00:00"
},
"marketing_segment_id": "ac511b91-1f6d-4077-8348-a25dbb347ac9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dc929c07-bf86-4c11-a168-74abe1fb144d",
"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": "79ab322c-531d-47e0-856e-f964b0f0ede6",
"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": "f2c218d8-dfed-4646-937c-716abfb9eaaa",
"db_country_code": "sample string 28",
"feelist_id": "ff7e8442-b283-4817-b0e2-1a38c0e4748f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6d501b3a-eb48-4466-a7fe-74a07e6a7936",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "11875acd-fb4b-4939-bd6b-26db223f0cac",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-28T20:00:15.8939143+00:00",
"db_currency_id": "56bcd8e7-2958-4162-8794-61fbe0e4f623",
"db_currency_code": "sample string 10"
},
"company_type_id": "f4527866-7605-4677-ab2c-bf8f7124f9e1",
"company_type_name": "sample string 32",
"company_type": {
"id": "3538c756-3b3e-477f-8647-32977956e8e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7d5835e3-cd2c-4ef4-9cea-0a0b48b04921",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c0002349-4705-439f-b249-6f9aa3980f71",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "275a4ddd-7d2c-4634-8d03-41f9042e2878",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "621180ca-4926-4b21-a746-c30afe6f304e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "76af139f-3fda-4124-bccd-3134ce0f1ee5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-28T20:00:15.8939143+00:00"
},
"company_sector_id": "2ee8d9d9-084b-4439-ad40-b991f2c08e6b",
"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": "1617900c-08fc-4be8-bd6f-61bea1f0a792",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1f853adc-73ef-4fda-b6e1-264d31dcc422",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f925e550-5dc3-43b5-83a8-9e3d6883143f",
"account_manager_user_code": "sample string 56",
"company_status_id": "3ea1c4be-9cad-4a7c-a6c0-73a6aceb7e28",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-28T20:00:15.8939143+00:00",
"id2": 60
},
"db_language_id": "2b585a41-c8a0-4ee1-abc7-857ea2baae8e",
"db_language_code": "sample string 7",
"db_title_id": "6e978330-36ea-4fea-ae40-f2fc85f5ba79",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-28T20:00:15.8939143+00:00",
"create_date": "2026-05-28T20:00:15.8939143+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-05-28T20:00:15.8939143+00:00"
}