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": "ab1b5256-af78-4ba2-9dc1-e72dadbe8b3d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "620c3980-8b90-4a01-8727-72e9f946b3d0",
"company_code": "sample string 5",
"company": {
"id": "ccb34c45-55b0-4877-b3b5-ed479d413a40",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-02T06:56:33.5263048+00:00",
"sales_territory_id": "ec0b16cd-8eb7-448c-8ede-3015a51e7a90",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eb7a3733-8f75-49be-9029-7b04e5b1efd7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0025639a-9bbf-47cf-a8b0-e89a7a36d7e8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2cb9c2c-4a13-4c47-8ea2-897853895a79",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8e3c2f59-8889-43d3-940c-206d8a5ec8de",
"db_currency_id": "ac0a52e4-8b3b-4d85-88ff-f73d001898c4",
"db_language_id": "ee0ffab7-2bd7-40be-b179-d83a83adfddc",
"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-06-02T06:56:33.5263048+00:00"
},
"modified_dateutc": "2026-06-02T06:56:33.5263048+00:00"
},
"marketing_segment_id": "b2a6e6c3-6043-4f77-9827-1c23ef595e68",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "38c2d1bc-80ec-49e0-968b-87ce425ecfa6",
"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": "23aa11d7-928b-42a7-a8d2-fc4ad3aef98d",
"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": "f8232ad8-4b64-4494-bddd-ef1560b6d40a",
"db_country_code": "sample string 28",
"feelist_id": "3ef61c19-2421-4fdd-a791-7d232977279c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2913d043-a40b-4867-951c-71043291b72c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1e376c7c-2fe4-4e74-af68-845a88a02111",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-02T06:56:33.5263048+00:00",
"db_currency_id": "c26082ca-3508-4d0c-89f5-f58eacb05ce0",
"db_currency_code": "sample string 10"
},
"company_type_id": "c835e6c9-a8ad-4c25-b79b-ffe83f1b18f4",
"company_type_name": "sample string 32",
"company_type": {
"id": "eb6e64f1-a821-4bb3-857c-079a6baa03a2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "309df77a-8c7e-4638-9a90-774f1a8787fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97380afb-276d-4ca5-921d-a1ffaaa52e5b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3faa30c2-82f6-4cde-8131-6ec08af67b69",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "96cb703f-ab90-4b3a-8efb-a7545eccc181",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "13b0da6d-2bd7-4c2d-88bb-79c820d074ff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-02T06:56:33.5263048+00:00"
},
"company_sector_id": "8f616265-eb28-4fb9-91a4-142153a10847",
"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": "5de0084b-c843-4368-a404-b5850414afe9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2c227e6a-40f2-4287-adb6-a0b6d54712b7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f31ae904-5f4c-4a88-a262-2d3a95925f3c",
"account_manager_user_code": "sample string 56",
"company_status_id": "04ae747d-1f25-469c-9ab4-03e7e441ebd2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-02T06:56:33.5263048+00:00",
"id2": 60
},
"db_language_id": "2e697541-32da-4025-8502-8c33cef9fd44",
"db_language_code": "sample string 7",
"db_title_id": "f1b1f7c8-ea80-42a2-8b77-6825abfe1610",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-02T06:56:33.5263048+00:00",
"create_date": "2026-06-02T06:56:33.5263048+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-06-02T06:56:33.5263048+00:00"
}