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": "c8a6cb9b-f45f-42d6-84bf-bc9112584ff7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9d837dd8-1852-4425-96e3-40c10b0d28fa",
"company_code": "sample string 5",
"company": {
"id": "e6646357-f41f-4161-980f-f0c381a6d078",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-25T04:44:58.5142383+00:00",
"sales_territory_id": "7eb78eb1-0778-42c4-88eb-7fa3b2b24f38",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "151aaeed-251c-4381-953f-d07f0e9dd7af",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bea43092-3506-4b83-8ebe-52af4b59900e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed0e026d-0705-4527-9bd4-bc84a9a0e94e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "45eb805d-ea45-4b69-83f9-c90d15e0154a",
"db_currency_id": "9892d4be-b509-4246-88df-0e2b9f6c02d1",
"db_language_id": "9d80e0ba-fc63-45cb-9ea7-e91485a95fd3",
"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-25T04:44:58.5142383+00:00"
},
"modified_dateutc": "2026-06-25T04:44:58.5142383+00:00"
},
"marketing_segment_id": "0687366f-b81a-4af8-a1fe-ff4e944678a7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b74054e-6964-4873-b1b0-5043244e7ab1",
"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": "e1e68fe3-c791-427e-af79-ea580fae6e99",
"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": "7836ef83-013b-4407-b053-4ceb13998d48",
"db_country_code": "sample string 28",
"feelist_id": "cb006d72-d179-44d1-a125-c05359494933",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8cd749c9-b0c4-4e20-ada5-6f5c4bd5e119",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cdd612d8-b5db-4124-8a9e-130fda14cf7c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-25T04:44:58.5142383+00:00",
"db_currency_id": "c04d6585-f475-47da-b6ba-9f5592a94023",
"db_currency_code": "sample string 10"
},
"company_type_id": "b9faf92b-b1bd-4a4b-9853-c6dd3fb91189",
"company_type_name": "sample string 32",
"company_type": {
"id": "1c2c57b2-5c78-48cd-a7c9-5d40caabf5a6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e65ef15-ad74-4224-a0fd-eb947e2ee71a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8c016440-206d-41c4-a43d-7bff230fafa8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eab19096-eb0c-4274-bc01-17980d5f6d48",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "18edb3f7-b897-46a8-a4cc-e3211851d65e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a1d8ce37-a99f-45ee-a937-14ac05bda57b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-25T04:44:58.5142383+00:00"
},
"company_sector_id": "384023bf-7377-4a51-89ea-b77d003dd6da",
"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": "5f6e9dec-79c0-4203-96ca-ea9dc9b47fa9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a40dd1ef-8da7-401b-999d-4f846139053b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "395ec601-ca7e-4bd0-b9d9-20ddb3021cc1",
"account_manager_user_code": "sample string 56",
"company_status_id": "bcc02817-8fd2-4de7-b947-ce569c291f52",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-25T04:44:58.5142383+00:00",
"id2": 60
},
"db_language_id": "6c69d95f-b010-4597-8edc-1a982bb28542",
"db_language_code": "sample string 7",
"db_title_id": "dfc7f1e4-0481-4ee5-b08e-4a5e68b4b723",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-25T04:44:58.5142383+00:00",
"create_date": "2026-06-25T04:44:58.5142383+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-25T04:44:58.5142383+00:00"
}