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": "6b04cc8c-7a0f-4907-834e-9015904344e6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d72382af-6420-461a-bb62-10e2433ddfde",
"company_code": "sample string 5",
"company": {
"id": "5f35ec08-7a02-46ef-8032-b1778e527360",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-01T06:28:09.274267+00:00",
"sales_territory_id": "c8c49a7d-a434-4106-ab94-382765473260",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "68dd17b1-31c2-499f-82db-50bc614216a3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a726b4b7-e62f-41d7-9085-d28ce11357c6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "170aab04-0752-445c-894a-3b982b247f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd1e57a4-5ba1-4bfe-ac6b-cac58fa9e8bc",
"db_currency_id": "ed272046-1f1c-4bf6-92ff-9362440e8ff0",
"db_language_id": "a856a9fa-4503-493a-9926-7a8ce03b1fb6",
"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-01T06:28:09.274267+00:00"
},
"modified_dateutc": "2026-05-01T06:28:09.274267+00:00"
},
"marketing_segment_id": "4c7d11cb-df15-4c16-8ec0-c01546b9df5f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "70bbd6ad-f5cb-4a95-a965-c8454287bfef",
"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": "55478d66-73b3-4a38-9976-a17f38a1ea57",
"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": "be293d96-556b-4551-bee8-a9f5ad66a9a2",
"db_country_code": "sample string 28",
"feelist_id": "b621fc1b-e1bc-48c6-b500-24a16a2fdbdb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9e66f87d-9acf-482e-aea8-73a1b8ec0c7f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "abed46a9-e241-4d66-b491-bdfbb7897476",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-01T06:28:09.274267+00:00",
"db_currency_id": "48510dcb-85b4-4208-88ca-507d2f6cf38f",
"db_currency_code": "sample string 10"
},
"company_type_id": "539abeac-997a-423b-a54d-f5e839088d51",
"company_type_name": "sample string 32",
"company_type": {
"id": "e7f2b5d4-4fc1-4693-8a25-5eb970a68e06",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6a2bacf3-ff9b-4d9b-9b01-5f7b34344bc6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ff5bacb4-3e3e-4c9f-ba59-ac8702890734",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0413d113-ca4e-409e-8359-2693fbcb3f96",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e373e9d-e431-4750-8a75-68648c2bb536",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8de21822-aaca-4624-abe4-5093d1c02573",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-01T06:28:09.274267+00:00"
},
"company_sector_id": "179ea9f3-2e82-405e-8cd6-6dda0af4a902",
"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": "d6af1d8c-d832-43a3-8260-12e68582c224",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1cba1cfd-227d-4ba9-9729-64a6c09059d7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eca0294b-bf87-42cf-9f1c-9c5db77efc07",
"account_manager_user_code": "sample string 56",
"company_status_id": "e3f41633-31a2-4bfc-986d-259415e8401f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-01T06:28:09.274267+00:00",
"id2": 60
},
"db_language_id": "c7b02f77-1420-404b-a4ee-da8884f0bcf6",
"db_language_code": "sample string 7",
"db_title_id": "bebbd6ec-3b31-47cb-93e5-4b3dcedbcc42",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-01T06:28:09.274267+00:00",
"create_date": "2026-05-01T06:28:09.274267+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-01T06:28:09.274267+00:00"
}