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": "2137fcff-fa75-4e45-b3c5-b8dc5dbea867",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "29992a82-4dc1-4816-8cdb-00593db4ff3f",
"company_code": "sample string 5",
"company": {
"id": "1ce282df-f40b-4006-888b-02af773a0c32",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T03:50:23.5011563+00:00",
"sales_territory_id": "9c632b7f-d47b-48b2-9fbf-8f96737f2b8a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "842f98ed-9dcd-4861-8559-9f4b20b8de31",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4918fde1-c320-4a1a-ace2-439b07a513d8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "985d9594-9126-4b99-8e5b-44acee66f0d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71c2c045-4015-42d0-a1a4-a1f547646210",
"db_currency_id": "284fbeb7-9806-42f1-8607-6c9a8a3f762a",
"db_language_id": "f123a2f0-7e29-4bac-abe0-0835d7114492",
"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-04-18T03:50:23.5011563+00:00"
},
"modified_dateutc": "2026-04-18T03:50:23.5011563+00:00"
},
"marketing_segment_id": "dbcc07d8-376e-4d0d-ba76-d95a79e837aa",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d2b399ef-ddd5-4ccb-a564-2313c709158e",
"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": "04ad2087-68dc-4f90-8865-40e87f3872f5",
"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": "746ca180-230a-4233-ab8f-78f0498258fc",
"db_country_code": "sample string 28",
"feelist_id": "dcb3e834-ab9b-4487-99ba-704eccc640e1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "08e81e55-1e13-4b17-9b7a-685d8109f5f0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "60d770a8-ce41-4832-bce8-dc677adcd747",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T03:50:23.5011563+00:00",
"db_currency_id": "ecbff6ba-8a39-4dcc-9fda-0f4ebc2ce582",
"db_currency_code": "sample string 10"
},
"company_type_id": "7b261ac7-32ef-487b-8194-a10fa8836bee",
"company_type_name": "sample string 32",
"company_type": {
"id": "cb62128f-74c6-431f-83fd-d79b882c50d1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9274a837-812e-4688-a93e-c15b7bde38cd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36beeec6-a32d-4b73-b842-77bd8fcc601d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "35cd872c-4325-401e-bb80-1b1441fd255d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b8b8dca2-067c-487b-b5a6-8519a0ac4d53",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "76f3247c-bda5-49c6-8fc8-b84340d3f79e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T03:50:23.5011563+00:00"
},
"company_sector_id": "100a5085-e10e-4113-b212-8d7556bcc5c9",
"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": "94094c55-112f-4f87-a95d-3a8512ddfdf8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "13cd3956-3a74-428c-98a7-0cdf8ca388a0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ef9fdcd5-0c92-4dd5-9f21-86ac1db50cc5",
"account_manager_user_code": "sample string 56",
"company_status_id": "e0a30841-ed3a-4644-99eb-4dfa3b5dcac7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T03:50:23.5011563+00:00",
"id2": 60
},
"db_language_id": "701fb1e1-0af6-45ad-9cc9-f47dbcaa8589",
"db_language_code": "sample string 7",
"db_title_id": "ab5c2f24-72d3-43dd-93be-28161765f9ab",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T03:50:23.5011563+00:00",
"create_date": "2026-04-18T03:50:23.5011563+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-04-18T03:50:23.5011563+00:00"
}