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": "08a40a44-3ae4-45b2-a7cf-1eca4bea3051",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4a75ed46-ca25-4bdf-8c95-99bf8f074f39",
"company_code": "sample string 5",
"company": {
"id": "e2893b48-daf2-4019-a692-a08ee73d8fa1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-03T19:54:34.8241499+00:00",
"sales_territory_id": "fa7f1934-b626-40d8-ab75-247b78b2e78f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c3f718d0-11a6-45e1-b9e8-8be1a821945a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88cc0fdc-1760-49c0-a031-55a9391fad4c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f6b44092-aaf5-4566-b36d-e7ae644b92d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5bad9610-d757-4df8-9db2-1b5a81150faf",
"db_currency_id": "529caf67-d4e0-4625-8f2f-438cae88087f",
"db_language_id": "e73de195-9a07-4017-8927-40822b9722a4",
"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-03T19:54:34.8241499+00:00"
},
"modified_dateutc": "2026-05-03T19:54:34.8241499+00:00"
},
"marketing_segment_id": "44878992-abec-4fd7-ad1e-21b2e825006a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "db2a3847-213a-4f0e-a72a-316b5fdb771e",
"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": "f81aac54-52f1-4707-b538-0f4fc48ad85b",
"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": "69bd10ee-dc0c-4741-8ded-7a66e30bebec",
"db_country_code": "sample string 28",
"feelist_id": "c771acfc-6380-4f7f-995e-5567d7c53f9e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "19a666e0-98a5-440b-8920-43fab25ee447",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f143792-d698-4b95-9bfa-f73dcb0c5e44",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-03T19:54:34.8241499+00:00",
"db_currency_id": "66b47f8f-961c-41bd-bfc9-a93ede912c9a",
"db_currency_code": "sample string 10"
},
"company_type_id": "904f6357-bf20-4007-a9bc-0a88133cd4be",
"company_type_name": "sample string 32",
"company_type": {
"id": "8a16fbb6-edbc-4ab3-b7ab-a8b83c1ad2d6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88d328e4-0e8b-46a7-92c1-2eb68fd4d564",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4d6b400b-e143-4305-916f-ed664e95b090",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "72a55ff0-185d-4fc4-9cc8-79d35c1dbc99",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "db406de8-fe90-4df2-b50f-12a6c9eed039",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a8264a9a-6012-4a5e-96e6-684cb28587a5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-03T19:54:34.8241499+00:00"
},
"company_sector_id": "6dc32c13-2df5-41e8-9d4b-2882a15985ba",
"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": "8aab074a-a323-4c43-b5bb-dac94cd83c4c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3c367c20-d636-4cb4-8918-bda5c243a34e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6935f6ad-4740-41b5-9f36-d33fb23c634e",
"account_manager_user_code": "sample string 56",
"company_status_id": "5e3cc26d-a526-47a1-b29f-eef7a3ec75cb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-03T19:54:34.8241499+00:00",
"id2": 60
},
"db_language_id": "17c5740d-08d6-4f71-94d2-a8e50397ced7",
"db_language_code": "sample string 7",
"db_title_id": "466a6d7d-6a73-40d9-83b7-24ffca82055e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-03T19:54:34.8241499+00:00",
"create_date": "2026-05-03T19:54:34.8241499+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-03T19:54:34.8241499+00:00"
}