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": "a613052a-4837-43ec-b133-1bbecd1094e9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3ced46f4-a7b0-43e1-b251-ebb55640f717",
"company_code": "sample string 5",
"company": {
"id": "afb48f3a-d0d4-4d18-a7f7-2d50b9c18212",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-12T13:57:01.3541965+00:00",
"sales_territory_id": "6acb1112-584c-4d5b-970c-3ef8f1a05257",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9df10dcf-16ab-4b9c-bc74-c00bdef2d155",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d7acd8b-db37-4a9e-9bed-d22d39891785",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5721779d-73c1-4182-b5f1-f8926e3fd0e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bda58509-35a7-4112-a8fb-8f11b023ef4c",
"db_currency_id": "f10516ac-0443-4140-b1fa-a234b232b82c",
"db_language_id": "133c71ee-a81c-49ac-a83c-729ac75d2e5a",
"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-07-12T13:57:01.3541965+00:00"
},
"modified_dateutc": "2026-07-12T13:57:01.3541965+00:00"
},
"marketing_segment_id": "59c417cd-b2d4-403f-95a1-43ea9d098e9c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0f47fef-127a-4c7e-8bee-2dd8c2335f5d",
"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": "15d69bbc-254f-45ef-8fce-132ef8c920ed",
"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": "c49de411-431a-4748-953f-844fd6f769a3",
"db_country_code": "sample string 28",
"feelist_id": "b4170786-7dd2-4b59-8f9b-19ac6c4595c3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bf6106b2-bb6e-4b36-a707-e59efcee9e8d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ed53a8d2-169a-454d-8ee4-87cbbdb2d160",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-12T13:57:01.3698163+00:00",
"db_currency_id": "15bb5f2b-35eb-4d5a-89ba-dadf05b4456c",
"db_currency_code": "sample string 10"
},
"company_type_id": "8f302201-dea9-4b54-9f77-abf95316707a",
"company_type_name": "sample string 32",
"company_type": {
"id": "f5167cac-e53d-479d-b404-6170d2812e17",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9f20595-79b5-4c11-b15c-93e185b5b7e2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "be7603e0-2ffe-4cae-ad6e-8f1ce59569bd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4544db44-3995-4605-8879-4c5beffac68d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e66e844-715a-4399-873f-3b106513b819",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c930c7fc-0cce-4ac0-93ec-fc94fb03262d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-12T13:57:01.3698163+00:00"
},
"company_sector_id": "74d0991f-8f75-4771-ab88-6ffb757f245b",
"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": "be1183c2-4460-4ff2-a0bd-3077cb5e88fc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0fa49549-20a8-4bcc-b7ab-72e3f5331f98",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d59b0014-1c10-4106-b1b4-76efe057f95c",
"account_manager_user_code": "sample string 56",
"company_status_id": "fd0e3fc4-6609-4aad-b6f1-f048274d32db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-12T13:57:01.3698163+00:00",
"id2": 60
},
"db_language_id": "49b6cbb9-4e4f-4c45-9290-e075af560784",
"db_language_code": "sample string 7",
"db_title_id": "b0d65e48-d902-407f-88c4-ecdbeeb53378",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-12T13:57:01.3698163+00:00",
"create_date": "2026-07-12T13:57:01.3698163+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-07-12T13:57:01.3698163+00:00"
}