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": "6086b97e-ca75-43ed-a1df-a2a0df8527c9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ee6ed7d0-9106-4cc2-9aff-3800f6aa9762",
"company_code": "sample string 5",
"company": {
"id": "22134973-308c-4b49-93b2-9347373602b2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-11T19:25:43.456412+00:00",
"sales_territory_id": "56ba187f-88cf-4de9-b61a-090ca1a0ce08",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c767ce63-e985-4e69-bbe6-707744df4db5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "950c59ea-4e0d-4cfa-8036-e8bbdc6b10a6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ab42a755-84b4-43e5-9dbf-5ddb4774fbaf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c6e0b94b-0591-4e3b-95c3-09d58a7b80b4",
"db_currency_id": "89599307-6a1a-4c7e-a90c-84254592e65c",
"db_language_id": "532d4b1a-7be3-47d7-b740-a76e10fcbb1c",
"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-10-11T19:25:43.456412+00:00"
},
"modified_dateutc": "2026-10-11T19:25:43.456412+00:00"
},
"marketing_segment_id": "5a127b42-d301-4e05-8efa-0ef106cfb629",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f7f5df71-4cff-4e32-8daa-c8c68c6be740",
"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": "ae138326-99a4-41dc-8181-56195375ccf9",
"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": "4e002aac-ce01-4da9-902a-b57b5019ff59",
"db_country_code": "sample string 28",
"feelist_id": "fabc1e92-6c6a-4642-b142-dfe4749885fe",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "42756421-77f3-4331-8b7a-bc71b009ef41",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "abbe461d-2644-4b72-937b-b8f3123f3d74",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-11T19:25:43.456412+00:00",
"db_currency_id": "c8ac821f-9551-483d-88a3-bb9934709a55",
"db_currency_code": "sample string 10"
},
"company_type_id": "9d432611-819a-4898-8fc5-b665869f1d73",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ca1f58a-f329-4ba2-92d6-b358bd381405",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b30bfe8-64c1-43b3-a7cc-06a9f10f5e80",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97a048ed-8483-438d-85e1-76573bd03e25",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "83999aac-7470-45d8-b2ff-562d84a2c3d4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "553cacc1-8de5-4d99-844b-599046e84c8a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6290fe50-a667-4388-bedb-7d8d40c9a274",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-11T19:25:43.46893+00:00"
},
"company_sector_id": "ff4f1e9e-f7c9-420c-8e49-90bee82d7591",
"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": "ba072004-155c-4620-bbba-cbfd78b4d7bc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "34fc94db-e9bd-4b93-8133-c2b2c243f276",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1bac5808-f658-480a-ac24-154b3af98008",
"account_manager_user_code": "sample string 56",
"company_status_id": "6c008f3b-34cc-4150-b1b4-97cfe45d039d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-11T19:25:43.46893+00:00",
"id2": 60
},
"db_language_id": "1d90f864-c35f-48b8-b738-f85bd34e7a44",
"db_language_code": "sample string 7",
"db_title_id": "3bab6a87-4422-43d5-952a-b3a4033611ed",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-11T19:25:43.46893+00:00",
"create_date": "2026-10-11T19:25:43.46893+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-10-11T19:25:43.46893+00:00"
}