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": "73c3b9b8-3240-4ce8-a084-1e6ca640787a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "709751d2-40a2-4f9f-9ace-22ce61fef078",
"company_code": "sample string 5",
"company": {
"id": "9a432b73-0355-4806-a100-aab6d39d4bba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-12T06:16:28.9700054+00:00",
"sales_territory_id": "9d2f86f0-05c6-4025-83d3-5c35c398c9ca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6da16728-d0fb-4d11-87e8-1496a0969bd8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "efc27fbe-d8b9-480c-b041-31a74ca7ded8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8cc3aa61-e542-4ef8-91c3-777e9e563297",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64df40bd-741a-49e0-9d5e-03a1d1105397",
"db_currency_id": "373bef56-7ca3-48d1-8064-708453883a85",
"db_language_id": "bbe00e11-6c52-4353-8d55-94a07bdf3711",
"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-12T06:16:28.9700054+00:00"
},
"modified_dateutc": "2025-10-12T06:16:28.9700054+00:00"
},
"marketing_segment_id": "e0f5b255-82f2-4b7c-9223-43de4a232e75",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d49ef447-dede-41d3-9092-61e1f3191c24",
"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": "716d62f3-0404-441e-a88c-a57db85d1f69",
"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": "9cd9e840-13f6-441e-9fc8-f786064481bd",
"db_country_code": "sample string 28",
"feelist_id": "52cec802-2d25-40f4-a1f7-bb6b544333bb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "064074ec-160a-4131-a00e-1d65ecd057c5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f09a343-ed3b-456e-8b21-2d17881dc347",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-12T06:16:28.9700054+00:00",
"db_currency_id": "5b70b94a-41c0-4abb-bbcc-5c523f962105",
"db_currency_code": "sample string 10"
},
"company_type_id": "7c604a7f-1bdb-417c-baee-0fd486599656",
"company_type_name": "sample string 32",
"company_type": {
"id": "d9514465-87e5-4ef8-ab59-5116a151dfcc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d9e1587-1ef3-4970-98cb-5d124f8a67dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e63ff3f4-f92a-4ae9-b7dc-e16dd0c122ce",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0386505e-0aac-46d3-b891-bcd300939ef3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5a0db7a8-3e5c-44c5-a2a8-37348d606991",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ada0a5ed-3c37-46f2-b63a-28a0bb3cecf9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-12T06:16:28.9700054+00:00"
},
"company_sector_id": "7232b0db-4d1b-4929-a1d1-89698de0f8d4",
"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": "0863443c-70f3-4243-b8f4-3f4504cfced3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8aa9fb1e-b35b-45d8-bc64-e80ba0a3391e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cc0985bd-e27a-4097-b3aa-d97eeccc0396",
"account_manager_user_code": "sample string 56",
"company_status_id": "55fa580b-abbf-44fd-b84e-a0dae8e9d7a0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-12T06:16:28.9700054+00:00",
"id2": 60
},
"db_language_id": "6d250b2d-d1f5-4196-9c44-7dfebfca049e",
"db_language_code": "sample string 7",
"db_title_id": "1b515a43-cd9a-4299-b96f-0a11b8b873c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-12T06:16:28.9700054+00:00",
"create_date": "2025-10-12T06:16:28.9700054+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-12T06:16:28.9700054+00:00"
}