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": "c4797aaf-ab63-4512-8017-f8723c022a72",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b2bc6415-5c3e-46d9-8719-0513e118501c",
"company_code": "sample string 5",
"company": {
"id": "c4549725-ffe8-40ad-ba39-5739b4897746",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T06:17:49.309914+00:00",
"sales_territory_id": "3ea76fe6-db8f-4855-be5b-bccb4bd0f293",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5f687e3d-87e8-4d3a-b808-4111295f0636",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "722fbd15-ec86-4c3b-93b8-f6d58a734909",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bbd27dfd-71ee-4967-b362-8ecf072eb16c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24520f0a-61eb-47de-bc0f-34009a473d0e",
"db_currency_id": "d586b708-6fcd-4ff4-b355-d2c43dd45bd6",
"db_language_id": "f680a7af-6ede-483f-91b0-6e1b66969823",
"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-06-05T06:17:49.309914+00:00"
},
"modified_dateutc": "2026-06-05T06:17:49.309914+00:00"
},
"marketing_segment_id": "8fc5b6f3-a617-45f3-a8f8-8bd90f59bd46",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1f929adc-567f-478d-b836-539b1497216c",
"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": "ef08a697-3cae-48ec-993e-92a46051d3eb",
"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": "97887df8-6448-4a15-8e1c-76c94d2077af",
"db_country_code": "sample string 28",
"feelist_id": "21f96c6f-c072-4f7b-b66a-915384e67e0f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "975cbb99-dbee-4f27-89be-626a14efa525",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3a55ca42-d45d-4f9b-8fe9-08c63608e606",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T06:17:49.309914+00:00",
"db_currency_id": "5f1da148-5f49-4f71-8dab-146fcd4df794",
"db_currency_code": "sample string 10"
},
"company_type_id": "cf9f9f9a-40fd-4e81-b094-560c7df030c0",
"company_type_name": "sample string 32",
"company_type": {
"id": "ece29d72-758a-498a-8190-09970773d4d2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bbc4bac7-0242-4b51-9061-6ca1e833986f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "12f7266b-1d3e-45ab-97b5-e582d7877891",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d5d8b8ce-f8d4-464f-9fe3-6b9595d52628",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "42e1af76-f9b0-44c5-a0db-5ccf95e294ac",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8149884b-63ab-4c27-9106-640c6f66b502",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T06:17:49.309914+00:00"
},
"company_sector_id": "89566d20-5339-4dd6-9c75-e3e12cacfb10",
"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": "2da248ac-07fa-49e3-a3c2-6a0d4e0b67e5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "816935b8-bb62-48aa-8f06-3533379f5ff3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "55a65396-13c6-40ab-8826-91d7e08bdce1",
"account_manager_user_code": "sample string 56",
"company_status_id": "97c1df4f-2bcf-4861-8223-15ed80e6506b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T06:17:49.309914+00:00",
"id2": 60
},
"db_language_id": "bd117ead-f752-4611-8bcc-74ead93b2f50",
"db_language_code": "sample string 7",
"db_title_id": "8bf82943-fc40-43ce-b620-2693a4f6d263",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T06:17:49.309914+00:00",
"create_date": "2026-06-05T06:17:49.309914+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-06-05T06:17:49.309914+00:00"
}