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": "891b4249-b75d-474a-babc-92cbfa1e1524",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3028ae6b-16b9-4aa9-9df6-3a696fb147ef",
"company_code": "sample string 5",
"company": {
"id": "7de0e21f-2c96-4c76-adbd-d316ee68294e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-02T05:18:51.6909875+00:00",
"sales_territory_id": "aed8db37-006a-4bfc-a000-64396ce60053",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "34ec4052-b710-40d4-a60a-db816da28780",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85bfea12-2a0e-441c-bce0-c26a036ad3ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "daee0403-a776-48e9-b35a-4ca57fc0263f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aa5cbf3-026e-45ac-bac6-aa6729e13d2d",
"db_currency_id": "6892d016-0a49-4a88-8e62-5ea360fac0aa",
"db_language_id": "31588594-0714-488b-8d27-a8c1c5b31e01",
"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-09-02T05:18:51.6909875+00:00"
},
"modified_dateutc": "2026-09-02T05:18:51.6909875+00:00"
},
"marketing_segment_id": "fc42b112-830d-4bca-a91b-8e8dbbccd98b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9f283377-da4f-4dff-a242-f95572545f21",
"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": "fe755142-52a4-4a52-941a-07e4d481f9a1",
"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": "936c7d5b-6577-4f93-a7f5-db1db168ef3c",
"db_country_code": "sample string 28",
"feelist_id": "661e35c6-227a-4f12-bb2e-ccf3bb4cbf33",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "23b52d76-6b13-4502-a1f4-658c2bbb796e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "69af70e9-dfbe-4ffc-96be-240673a775d1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-02T05:18:51.6909875+00:00",
"db_currency_id": "d7270541-7925-44db-b9ec-340891d8728f",
"db_currency_code": "sample string 10"
},
"company_type_id": "6e46b0d5-db3d-4763-a065-37cbe7fbd5ae",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b3201d5-043d-49eb-a352-166c685baf18",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e9cd15ef-88a7-4d6c-a4a2-dc120fd23718",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2f856624-d1d4-4359-81eb-fb423e81571a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8fafc5ff-fa53-4d8a-b500-3db9ec8a76d7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4e5f4224-39af-4033-b49f-d18a2b0d705b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a55f702c-7c0d-4621-9016-81d628d0dd79",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-02T05:18:51.6909875+00:00"
},
"company_sector_id": "dc6de059-0ede-4c0b-b3a5-208326ab41bd",
"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": "c5cede82-07de-4ba3-853c-752589f59d25",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f2ddf22a-5b3a-4b6b-905c-ea34e6a18f0c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9f1cb510-276c-4974-b755-f51908c69fcb",
"account_manager_user_code": "sample string 56",
"company_status_id": "1d131c0c-7f1e-4744-9169-2577f8a7a4db",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-02T05:18:51.6909875+00:00",
"id2": 60
},
"db_language_id": "bd897fed-7832-4690-a470-f37b3b9b8f04",
"db_language_code": "sample string 7",
"db_title_id": "77bcb5b7-d1d5-4e4c-9d63-8702c076d2e2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-02T05:18:51.6909875+00:00",
"create_date": "2026-09-02T05:18:51.6909875+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-09-02T05:18:51.6909875+00:00"
}