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": "2086c3b5-fc02-4eea-811c-393fabd4f162",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a250240f-8823-40b6-9135-f014a27eed9b",
"company_code": "sample string 5",
"company": {
"id": "33d104ed-e7c6-4b33-aa11-7d96bcbd38a4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-16T03:51:29.6617607+00:00",
"sales_territory_id": "94d7e159-105e-4f7d-b709-6fc05a9728ec",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "271eebaf-87ab-43c0-8bee-8b8c0b1ac8e4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "95d29ad8-1e29-4019-acf9-85712b267ac0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "744a55c2-557d-4a14-8439-ab87f4002f96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fb1ab34-8fa6-40ea-ad1c-5b10b179b597",
"db_currency_id": "ad2df48f-4d16-479f-b4f5-47eb130d7628",
"db_language_id": "cd4174cd-cb1e-4e79-87e4-5925bc8143c3",
"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": "2025-09-16T03:51:29.6617607+00:00"
},
"modified_dateutc": "2025-09-16T03:51:29.6617607+00:00"
},
"marketing_segment_id": "a07d9cec-7e36-4915-ad64-0dc374f62a6d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e131bd88-67b4-4e43-8b31-2d4ea0c9f11e",
"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": "70aeab3b-5e53-460c-b440-41cf1b44b263",
"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": "e82c4819-e3cc-4fcc-afee-ff8765dca64d",
"db_country_code": "sample string 28",
"feelist_id": "06f9d0b7-241e-4c7d-a7bb-5094e9e07be7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "db14151c-859c-4017-ac0c-ab34412ddf2f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5e80a237-ac4e-4c2d-b875-0af70e4ff598",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-16T03:51:29.6617607+00:00",
"db_currency_id": "5eda93b6-f83b-4a47-b35a-fa19b56b7a6a",
"db_currency_code": "sample string 10"
},
"company_type_id": "12e60c5c-107b-4b2c-a18d-e707bef591a9",
"company_type_name": "sample string 32",
"company_type": {
"id": "9985ba47-0a59-492b-a41d-ba510f7362ed",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "43729a11-ed07-4ea9-b6a9-24edf52bae0c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3f702727-eaf7-4dfe-9f13-b70d5a823b0e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "65035818-6c87-4310-b2ed-abf3c71c062b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f6277a54-9d6d-41fc-9c89-f39bbfcd05ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad067d10-b53e-4967-a906-bedfa94d4066",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-16T03:51:29.6617607+00:00"
},
"company_sector_id": "e6260e56-68ed-4206-9fb9-c92cf60ac070",
"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": "069a1a4b-5dd5-4256-92bf-a0ff312af781",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ce51a30f-4ca4-41df-b354-59c97d201572",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "882581b6-4f9f-4129-954a-7a1b38e6118e",
"account_manager_user_code": "sample string 56",
"company_status_id": "bca75b52-dbc8-43e7-8b4a-0b3b1e339bbb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-16T03:51:29.6617607+00:00",
"id2": 60
},
"db_language_id": "d7472e58-8329-403a-8018-08f291c885e1",
"db_language_code": "sample string 7",
"db_title_id": "85ddf212-720c-4f0b-a3a0-d193935ef63a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-16T03:51:29.6617607+00:00",
"create_date": "2025-09-16T03:51:29.6617607+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": "2025-09-16T03:51:29.6617607+00:00"
}