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": "15a6407d-4b04-4ace-a84a-bebab5ea5954",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fa18ab3d-4aa0-4256-94b0-1696123a0120",
"company_code": "sample string 5",
"company": {
"id": "29573ad6-120b-481e-afad-b92cdcc491f5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-27T08:16:25.3842658+00:00",
"sales_territory_id": "8f2890a3-3bb4-48fe-b3b7-4e85cfc5b3cb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b9a9cb86-c685-4d4d-ad15-b701b01609cd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93f7a611-b05d-4ef6-99c7-575f00113526",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0cd07985-7a8c-4ab8-9df7-8a121db0590f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d82e255c-1ef9-4737-8334-2e35b15968de",
"db_currency_id": "b57cb712-9a83-4bed-838a-ec75a50dd9c9",
"db_language_id": "19d99f24-6954-40f4-9abf-d001a9134128",
"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-01-27T08:16:25.3842658+00:00"
},
"modified_dateutc": "2026-01-27T08:16:25.3842658+00:00"
},
"marketing_segment_id": "432a2d67-ffdd-4628-80e7-1539c5820931",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "562d798c-b3b3-480e-a0cb-bba94c8e46ce",
"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": "66575f1f-5900-4565-80b9-5711e465d320",
"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": "9d8ec478-ffaf-4495-86ae-1d3499cd2be0",
"db_country_code": "sample string 28",
"feelist_id": "8d66d8f8-664c-492b-ae07-72add24a7570",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e0fe8da0-69ba-4397-9848-ad1432f9bb55",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9d495c88-18a0-4df8-915b-e59596e70407",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-27T08:16:25.3842658+00:00",
"db_currency_id": "e1f2241a-81e0-4c55-a687-a70ee1a34434",
"db_currency_code": "sample string 10"
},
"company_type_id": "b955ea55-6141-4cec-bdd1-7eb897f05d62",
"company_type_name": "sample string 32",
"company_type": {
"id": "b3892c64-1c82-4d54-9af1-32e496dee76c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5ce2918-fe6d-4ec1-9005-e705ca0ff35a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "31b0210e-493e-4deb-a67a-61eca3a45109",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e6d26f5-a32e-4dfa-8117-d43beebcccdf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4b9e7576-aa96-476d-bb13-6ff8cc6b4742",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e0841e89-4d7f-403c-92a9-2772b6dcb4e5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-27T08:16:25.3842658+00:00"
},
"company_sector_id": "4aad32d0-e763-46ef-a4f4-b379f74b82ba",
"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": "a3c32b3f-bae2-486e-aa9f-04e95b370a33",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "972133b9-ed7a-405c-a40d-ead05239b8f8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "425e0560-ded4-45bc-81b6-673b718ac457",
"account_manager_user_code": "sample string 56",
"company_status_id": "2bc63248-2d4a-4692-9637-96f98924072e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-27T08:16:25.3842658+00:00",
"id2": 60
},
"db_language_id": "56f0c065-7ef7-4d02-8d42-355082761b0b",
"db_language_code": "sample string 7",
"db_title_id": "d05100d4-2788-46f5-909e-cd769f7c1330",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-27T08:16:25.3842658+00:00",
"create_date": "2026-01-27T08:16:25.3842658+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-01-27T08:16:25.3842658+00:00"
}