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": "1c65fb94-209b-43a8-9af2-f9fef3547372",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5d2f7361-ffb3-48e7-94c4-9ec9a23d7a5f",
"company_code": "sample string 5",
"company": {
"id": "e351450d-f9ad-4083-90ae-9d2fef8fa377",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-09T01:46:54.7996103+00:00",
"sales_territory_id": "2ab793bb-cc6e-48be-94ec-29f635feabfb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b72e70bd-1638-404f-81be-85e6ad35892b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "78479f60-a383-456a-91b5-6d59c1592ebe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "434b5a4d-d2d0-4bea-a08c-6e179630686c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bcb4eef-d0a4-4674-8610-6233674660d6",
"db_currency_id": "d76ce1b1-eb73-4b7e-9ce4-18b85fc55b66",
"db_language_id": "0d43c5f6-5d89-43ed-a872-80fe7d5ab614",
"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-09T01:46:54.7996103+00:00"
},
"modified_dateutc": "2026-09-09T01:46:54.7996103+00:00"
},
"marketing_segment_id": "357d6fd9-a594-4afa-b701-1b339ad70ecc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7ef224ed-c287-43e2-b073-b0fec9a888f0",
"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": "0194926d-f888-4eca-9093-9c40054ec5c5",
"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": "756ea976-493f-4955-8714-717b75a0d026",
"db_country_code": "sample string 28",
"feelist_id": "f72c4543-31da-4a25-aaff-0710db4125eb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8827cb22-af3d-4b50-b54c-2f9bf0f5990d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "23a1b52d-431c-40d3-ad4b-0487200f94fc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-09T01:46:54.7996103+00:00",
"db_currency_id": "adf598db-e5cb-4c66-a6c7-ddbbe1055a3b",
"db_currency_code": "sample string 10"
},
"company_type_id": "162efe01-d799-428e-b29d-4568b5dd7917",
"company_type_name": "sample string 32",
"company_type": {
"id": "5ab6111d-6375-4156-ac07-c6f56a91138d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "217e09e5-1881-4571-b7b7-26c8be9f152a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e60f7539-3d65-4906-bbea-cea74a37695a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c30fa134-e9ce-4681-8f91-44cbe8d46c3d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "18b01df4-473c-41e3-bedf-5070ecc3799a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fdc1e745-d29d-44f7-a465-885cda39597f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-09T01:46:54.7996103+00:00"
},
"company_sector_id": "664df97a-881a-449f-835c-a74b7f35127c",
"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": "2edae176-61fa-4fb6-bc12-c5a63affa400",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "71d05a40-fef2-4b8c-9efd-c20e78da86e2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8f77122-7bbb-4d65-8184-385903a6499f",
"account_manager_user_code": "sample string 56",
"company_status_id": "579e3366-2126-4b6d-9d64-632d09a9623a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-09T01:46:54.7996103+00:00",
"id2": 60
},
"db_language_id": "f260f219-3c72-4e81-b762-f8ffbec039ad",
"db_language_code": "sample string 7",
"db_title_id": "111cdee0-715d-4a5e-be97-a278a60e3971",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-09T01:46:54.7996103+00:00",
"create_date": "2026-09-09T01:46:54.7996103+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-09T01:46:54.7996103+00:00"
}