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": "ad5f6e1c-4955-4ddb-b5fa-10ffdc750413",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0b64664f-676f-459a-a29c-970c3c2c1f98",
"company_code": "sample string 5",
"company": {
"id": "edd5db4d-7b9f-4aae-bdb1-9e3909e34ea3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-05T05:58:27.1051938+00:00",
"sales_territory_id": "215ec227-a113-48ca-ad02-3de6052799c2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6237c81c-bad5-4a26-93b3-ce02433a8f4c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2a3c2344-46ba-48f9-b053-ee37b824889f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bfe47623-6d1e-4a89-9cd4-30f7af269dbf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "556c204b-142c-45d2-8803-09a0c2008790",
"db_currency_id": "df522b40-8f2f-43b0-9542-411e85f27a01",
"db_language_id": "1f4d6d94-c4f3-41c3-a5c0-8ffd76d19509",
"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-09-05T05:58:27.1051938+00:00"
},
"modified_dateutc": "2026-09-05T05:58:27.1051938+00:00"
},
"marketing_segment_id": "91ccb38e-fce8-4307-aab8-0f7909883182",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d0c6d1c3-262d-4c78-a548-9e3b27dc37fe",
"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": "63ae8d6e-0550-4ccd-98de-5e8075e2efad",
"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": "f19e20c8-23ac-45a8-8c1e-1760a1a01a08",
"db_country_code": "sample string 28",
"feelist_id": "5b9612e4-dfb4-4389-8249-8b1e5579e128",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a3f40068-fa78-4862-826c-a943e818785c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2deb086d-f2d9-4a9e-8263-492e7871e859",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-05T05:58:27.1051938+00:00",
"db_currency_id": "ba701eca-a0d2-404b-8cff-876be6c08d65",
"db_currency_code": "sample string 10"
},
"company_type_id": "4a95ef88-3e49-414c-be5e-b7fdaeea390b",
"company_type_name": "sample string 32",
"company_type": {
"id": "04715e20-261f-40af-9d0b-dfae7e14ef4c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "034f818b-bb8c-4f09-a849-2e8d225cd937",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b7928ee9-42cd-450f-937d-b2dcf7e1d36c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c7cb9921-12c2-4356-af3f-f5a98cd32861",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c774648c-be3e-4f5e-aa73-24c4e62064cf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3adac06d-9dd5-4b1a-9895-38ea7f00e3ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-05T05:58:27.1051938+00:00"
},
"company_sector_id": "34726fde-cd40-4ca5-8c46-d041438b5837",
"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": "f4054bd7-88a8-4dff-8217-b1ade518ebb0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4f28da3b-fae5-4baf-83be-9820dacc80f2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c518bbd4-c49a-4b9f-b8ee-2dac690675e1",
"account_manager_user_code": "sample string 56",
"company_status_id": "e44a8e10-5b7b-4a03-92bf-90dcd7c1212e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-05T05:58:27.1051938+00:00",
"id2": 60
},
"db_language_id": "8d4bf488-df0a-4e35-89bb-6bae5941eff7",
"db_language_code": "sample string 7",
"db_title_id": "475c8387-e9f5-4716-a5ee-2a821c737c1a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-05T05:58:27.1051938+00:00",
"create_date": "2026-09-05T05:58:27.1051938+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-09-05T05:58:27.1051938+00:00"
}