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": "6f4acf90-e806-4bfe-a45b-765e7bd3fbf6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aad7ebf8-8795-4001-b9c2-34a059ed3294",
"company_code": "sample string 5",
"company": {
"id": "49696af6-645d-4e34-8c47-b2e18d83802c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-19T00:24:23.2184265+00:00",
"sales_territory_id": "288cc16d-5a76-45e3-a445-c3d0f13aa36e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "75290126-32b8-4e5b-a284-72bd092432bf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4dc2f979-ff4d-410f-a246-f2598d3790f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e45c86ed-5d03-4904-8211-b3784b274cb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0067ac49-5e55-4e89-84be-8aedf9554571",
"db_currency_id": "1155b7e8-f4c1-437a-8789-037dfa5f51aa",
"db_language_id": "db46dc3c-8b83-4d79-a320-328fb48f63c0",
"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-05-19T00:24:23.2184265+00:00"
},
"modified_dateutc": "2026-05-19T00:24:23.2184265+00:00"
},
"marketing_segment_id": "325234f9-537d-4909-b66e-974a6a93d6cb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f1e75727-0b62-49a7-95c5-79ed4b693cc7",
"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": "84c57663-c922-4ebc-be6f-cdffdad6ad57",
"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": "9330a532-d602-42ec-b8a6-04218a09f83a",
"db_country_code": "sample string 28",
"feelist_id": "c9e3f6bf-b36e-47ad-97d6-06459051a885",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ac333475-0a99-447a-aae0-32e39e5f8f5c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "54217725-a94c-4786-8331-78a77156408f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-19T00:24:23.2184265+00:00",
"db_currency_id": "f1b94ad9-cd5b-48bd-97ef-2f8c19256434",
"db_currency_code": "sample string 10"
},
"company_type_id": "67b4999a-b0b3-44a7-95f6-40e8d40d8f1a",
"company_type_name": "sample string 32",
"company_type": {
"id": "4088dcef-25c5-403e-be6e-fa797c85c3bd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1f24fcc0-d4fe-43f6-824f-3978caa979d1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1123581d-dbe5-4d91-bb61-e324a4c7d5c1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c4dbca74-4f45-4fb3-837b-541508b71ac6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "494f5cfd-24e8-4f6f-9be3-a64918405d19",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "21236eb6-0e5e-4071-8469-7fbfed5952f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-19T00:24:23.2184265+00:00"
},
"company_sector_id": "492cf6ab-2845-452e-8ec1-0707da2a403f",
"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": "d17344cc-89bc-4e6b-8002-956e003469f7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5f6167f6-9ec6-4dff-ae5a-25d29f7ea9c5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "70efd4e5-45d6-4009-b590-f8fc823b40c5",
"account_manager_user_code": "sample string 56",
"company_status_id": "4e4d03ed-5f7f-45ba-9969-936a02adafb2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-19T00:24:23.2184265+00:00",
"id2": 60
},
"db_language_id": "a8ab5024-5970-4642-a17f-2db8251b548b",
"db_language_code": "sample string 7",
"db_title_id": "e7521088-b66e-4f00-855a-017eed9ebba1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-19T00:24:23.2184265+00:00",
"create_date": "2026-05-19T00:24:23.2184265+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-05-19T00:24:23.2184265+00:00"
}