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": "dcefd728-4634-4d5a-91fc-97537b714ab4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "18e12de7-8f2e-4e88-a442-d9a56233a61e",
"company_code": "sample string 5",
"company": {
"id": "6c2f4559-9916-4048-aa0f-2d9c7195fce9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-10T00:07:47.3300449+00:00",
"sales_territory_id": "02bb3ead-7d96-4c6f-ba5f-07a191229e61",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "196adb1a-a886-4e13-bc7e-e50da91b87e4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91327ae8-b7ea-4ead-86c7-865dbedd42fe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e2614f3a-5d6d-494a-98a6-61749876a2d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ae048262-7195-4910-ba6e-83df5fd6a9e5",
"db_currency_id": "ce86bd33-c452-40e1-8ee3-270ddd22957b",
"db_language_id": "7c25bf1b-55d3-40fb-a133-8bfe4fdd828b",
"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-11-10T00:07:47.3300449+00:00"
},
"modified_dateutc": "2025-11-10T00:07:47.3300449+00:00"
},
"marketing_segment_id": "22fed53e-c1ae-40f5-b463-9d0ebea264a0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ef674c0a-3f44-4d05-8aec-c1bc77b3037c",
"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": "6b558de2-7225-4941-b491-0dcff1e24284",
"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": "ba188c51-a11f-4bd3-bbec-1ad172e016d6",
"db_country_code": "sample string 28",
"feelist_id": "2b5706b5-3a65-4f1b-b56f-8b05279965c0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d1086cb5-45a9-45b6-8d1f-95a0ce80dce4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8972feda-a3e8-4162-a0bb-4bc8a71dce60",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-10T00:07:47.3300449+00:00",
"db_currency_id": "df8573a3-2c38-4932-a20f-d4564ad9aaf6",
"db_currency_code": "sample string 10"
},
"company_type_id": "210d5f0d-4361-47d9-9490-040a2156f1dd",
"company_type_name": "sample string 32",
"company_type": {
"id": "ffbf4c3c-9c02-4fb6-968e-3d9eabb69995",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9d7c6209-bcb4-4378-8b6b-3c99fc5ca997",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c75f8946-ab71-4e4d-8bac-4ae77ac0e232",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "92a24113-ad17-456d-ac68-7befb10657b0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c94c1c3c-4bd7-4c30-aa08-1b25f08f67b4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b7d62633-deda-4697-b365-02fa0c85e075",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-10T00:07:47.3300449+00:00"
},
"company_sector_id": "16c1b510-bc31-4b26-b0c5-555385fa988c",
"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": "d7c51f70-cb9a-4359-81aa-5894e1340200",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a5832037-01b1-4a47-bafa-53126c015769",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "44638501-eb83-427a-96c4-860071768616",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f9462da-10e5-4d47-b877-af7f5721fb1e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-10T00:07:47.3300449+00:00",
"id2": 60
},
"db_language_id": "2f04e0f6-635f-43e8-aefd-ad254e16c1c0",
"db_language_code": "sample string 7",
"db_title_id": "b1e2e4a0-a7c7-49d0-b106-391de254a446",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-10T00:07:47.3300449+00:00",
"create_date": "2025-11-10T00:07:47.3300449+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-11-10T00:07:47.3300449+00:00"
}