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": "0b920f6f-7c56-4d89-b8c4-7257d6f874da",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1061313e-fa5a-4726-a33d-6a2ab1b07d04",
"company_code": "sample string 5",
"company": {
"id": "3db9c50a-9b6a-4946-9736-25da4091e772",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-01T19:42:39.7334053+00:00",
"sales_territory_id": "c07b32d6-39d1-4a33-bfd0-393bd203bf0b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "707686c5-dec1-4feb-a54b-4de81aefa012",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ca304352-3fc3-445f-937d-e880943fd444",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03fc3424-e60d-4f2c-95d7-8d2b140ba7f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24d88051-1e90-475b-9e5c-bf1259cf6a7c",
"db_currency_id": "c4c46a67-67eb-4b23-bc05-22c0aa465074",
"db_language_id": "74d447cb-4fd8-4981-a72a-924626cd30fc",
"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-11-01T19:42:39.7334053+00:00"
},
"modified_dateutc": "2026-11-01T19:42:39.7334053+00:00"
},
"marketing_segment_id": "6378bd0b-a986-462d-ba74-7efeba1d84fd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e8ed5fbf-c4f7-4739-9fc2-0256a168136e",
"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": "290bfa49-c61e-4229-978f-be9880face35",
"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": "b04425f9-2bfb-4ceb-8a56-1fcb9469d86c",
"db_country_code": "sample string 28",
"feelist_id": "ec44e057-a0c4-4041-89ce-bdd37ca8b9b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "84ea878e-4a51-4f80-81e8-a808b0a32916",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b97e5acc-6ec4-4a4c-9766-689cd3f65bdd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-01T19:42:39.7334053+00:00",
"db_currency_id": "3ea6975a-db45-49e6-bc60-799a3a4e84a3",
"db_currency_code": "sample string 10"
},
"company_type_id": "326bba3b-edfb-4abc-a609-c1bc62a4e8a3",
"company_type_name": "sample string 32",
"company_type": {
"id": "ad9fb1e3-6fe5-4f9b-a878-d8b21936447a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "027b3a1b-93f6-4394-b39f-36ceac2eaf43",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ec23ef1c-8484-4b3b-b0c7-812a47b8e8d2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4aaac8fa-cc81-4740-a351-b0907d55dffb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "86d38581-b6b1-4c8f-a17e-6dbb5e213614",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "38880a85-6aa3-4d00-8ed1-6500050386a6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-01T19:42:39.7534765+00:00"
},
"company_sector_id": "62b050d3-1ad1-48d5-8c28-b2ede213305d",
"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": "65133ee9-0378-4bc1-964e-aff5a5183d25",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "325f9fd4-e8d4-4eac-abf0-236d03102e07",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6bce6452-a6cb-4678-abe4-82d30ddc9df8",
"account_manager_user_code": "sample string 56",
"company_status_id": "79b3d2fc-344d-4e23-b1c6-b8bf36ff87eb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-01T19:42:39.7534765+00:00",
"id2": 60
},
"db_language_id": "99ae38b9-0327-40c2-8da4-7293c0e574b6",
"db_language_code": "sample string 7",
"db_title_id": "65f22df7-5604-4cdf-b6c8-ba3887e41edb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-01T19:42:39.7534765+00:00",
"create_date": "2026-11-01T19:42:39.7534765+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-11-01T19:42:39.7534765+00:00"
}