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": "2a3f90c5-ece5-4153-ba62-95eb716c9bda",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "47b701b6-b647-400e-a315-448983231516",
"company_code": "sample string 5",
"company": {
"id": "3a3a9438-f75b-4e8f-badd-99ea43ce3aa5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-06T23:05:15.1303687+00:00",
"sales_territory_id": "bfa84e35-6a54-416a-8b4c-18da67b53e00",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4c69f28c-304a-4aed-a0fe-29b88315cc09",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c70b57f-536c-4b3f-8606-9a49a2f174cf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "caa924ba-7d80-4103-a8d0-542102542e1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "221451e2-1379-4b07-91ae-7a9f1143878c",
"db_currency_id": "ba4936e3-68aa-49fd-9232-ed1fc67b2527",
"db_language_id": "7bda5cba-2be8-4e5b-a379-044451bd7855",
"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-06T23:05:15.1303687+00:00"
},
"modified_dateutc": "2026-06-06T23:05:15.1303687+00:00"
},
"marketing_segment_id": "a6ed71c7-712a-499f-bb24-36b939ffd852",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "78b65f85-a164-43a1-9dd1-66aa6bd5442c",
"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": "6ae671cd-e98a-4e97-9aea-173fcd7a3c1d",
"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": "8ddfe918-c05c-44d3-bfbf-312b75314b07",
"db_country_code": "sample string 28",
"feelist_id": "b7e47b93-1809-47f5-ad2f-80d6e53c03d9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4c404902-4e43-4704-a55d-612d9902434b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28a23572-03a6-4f25-8616-13ba71d333c9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-06T23:05:15.1303687+00:00",
"db_currency_id": "e24de64c-1e51-4816-8cc1-1e218326177f",
"db_currency_code": "sample string 10"
},
"company_type_id": "d9f52e83-5ae7-42c2-872f-455a0671a216",
"company_type_name": "sample string 32",
"company_type": {
"id": "7066d715-a3c8-4f38-8d08-cc74644b0c66",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "84710aa1-8e9f-4f10-b473-915b7dd99548",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9a67594d-8f66-44f1-9493-fcd7b8c9ac12",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b5a4949a-e23d-4656-aaa0-2be164a995ef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8b55489f-3a90-49b9-9412-42ab1a2713d0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dd5e1c71-e2c7-4915-90b2-9bc70e9943b6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-06T23:05:15.1303687+00:00"
},
"company_sector_id": "fef8bd22-0310-4320-a82f-77afd50e27d9",
"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": "d981650a-1fc7-4c24-8bee-57e37461ef1e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cb54fa64-6e70-46c9-ab09-a236f1cc8c62",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0ab77ae2-0916-4507-843f-b8f09d372911",
"account_manager_user_code": "sample string 56",
"company_status_id": "e13ffbd1-77af-40c6-a642-fb1a602fdd52",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-06T23:05:15.1303687+00:00",
"id2": 60
},
"db_language_id": "97b016c6-eaad-4285-8c22-4bfea11ba03b",
"db_language_code": "sample string 7",
"db_title_id": "fda31353-90c5-4dd5-ba17-86e4146f93da",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-06T23:05:15.1303687+00:00",
"create_date": "2026-06-06T23:05:15.1303687+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-06T23:05:15.1303687+00:00"
}