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": "1934d6dd-1798-4302-91c5-f3a52b17856d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "abea89f3-72f5-4e0e-969d-f1f63b391fa0",
"company_code": "sample string 5",
"company": {
"id": "74495fe1-4dd0-4b26-865f-7a0b6eb48073",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-08T03:56:57.763771+00:00",
"sales_territory_id": "ce6175ce-8170-44c7-95b9-ebb46227d10c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ba1e703e-ee92-4df8-89a7-e128a1837e3b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "519c49c9-f837-4a7a-a451-374cd766d7fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "87596ab8-75fc-47e5-b64f-14821b0a5d9a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2bd2fba-dbb1-479c-ac35-b887f96e7677",
"db_currency_id": "4bd94e1c-28be-4f2c-9168-4918fc3024b1",
"db_language_id": "cd68fd96-ebab-4829-b853-b54203efbfd0",
"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-12-08T03:56:57.763771+00:00"
},
"modified_dateutc": "2025-12-08T03:56:57.763771+00:00"
},
"marketing_segment_id": "4d661770-4056-425b-8006-0003e745de41",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c7b0d3b2-523a-4659-bb07-00caf231c155",
"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": "42424344-55ae-436c-abb5-b293a82d0413",
"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": "cedd732f-75f0-49e9-b050-61c295d159f5",
"db_country_code": "sample string 28",
"feelist_id": "660b7e74-0e9d-4d04-b8ac-fc41a4b61ba0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6f166854-f120-41b6-9a51-b78ee2696863",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0e317431-cd18-419f-a54e-6d9a8430872d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-08T03:56:57.763771+00:00",
"db_currency_id": "c5395424-a6c6-4b1e-9bd9-fdbed8e12ec7",
"db_currency_code": "sample string 10"
},
"company_type_id": "74d2181c-8652-4ea0-aaa1-8e3c8028692a",
"company_type_name": "sample string 32",
"company_type": {
"id": "7b0721ac-8ac5-4ece-af40-57dc2712a00a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "55efbc23-c227-4816-af9c-f24e5c4d86ab",
"sales_organization_code": "sample string 5"
},
"db_language_id": "717182ff-6a43-4798-9bba-07c1a63c1eed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "583788a3-249a-44c8-b64c-1aa937eb0f73",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7b4f45f8-e631-4139-8e71-959b772296c3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "279cc498-c226-40ed-bb86-b37f9718db5c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-08T03:56:57.763771+00:00"
},
"company_sector_id": "8f48752c-cfe6-486a-8d09-f9dc772a90d6",
"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": "f6cb9f69-0486-4e28-a968-7605e20c4575",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6da48796-cee1-4ef2-ab77-37899938a288",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e5379038-12da-4367-97a2-b0864f652083",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb29b7d7-4683-4182-852a-274002e9acc6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-08T03:56:57.763771+00:00",
"id2": 60
},
"db_language_id": "0680354c-fe33-415b-9dca-26dea891af65",
"db_language_code": "sample string 7",
"db_title_id": "1e2bad6b-e9d5-4ee7-a8c8-8667c1c7da48",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-08T03:56:57.763771+00:00",
"create_date": "2025-12-08T03:56:57.763771+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-12-08T03:56:57.763771+00:00"
}