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": "00f44fcd-dad3-43b3-931b-a0cf31a635e9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7d066438-d012-4c83-bb14-7c11a275ef32",
"company_code": "sample string 5",
"company": {
"id": "fcf0e0d8-fd20-40fb-a98d-9b0aefa0a5e9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-26T11:24:55.6240976+00:00",
"sales_territory_id": "928e8837-9897-4197-8a1d-6a3d4d60af88",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "59ff6624-9742-48fc-b625-110de413f485",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea8bf0aa-a891-4698-9978-dcda4c058556",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d2f7cbaf-b6bd-4dfc-bca9-cd1313d33b71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e46716-75e4-4621-a5c1-e29b18cabc06",
"db_currency_id": "287771c5-bf06-4120-b72a-d6183cba5d98",
"db_language_id": "c4019b48-45d1-4c8e-8cce-6461904a210b",
"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-06-26T11:24:55.6240976+00:00"
},
"modified_dateutc": "2025-06-26T11:24:55.6240976+00:00"
},
"marketing_segment_id": "7cf3e208-1b62-4394-af03-4b3be00b81ba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "23b47f7b-dc6c-45f4-a7d7-47c8e260b875",
"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": "96d27d10-e19d-42db-a362-8c82e1db2b79",
"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": "f0b5fc51-91f3-4366-ac53-c2ab0a9742b4",
"db_country_code": "sample string 28",
"feelist_id": "517be5d6-4eb8-426d-a7b0-f03757ece7c3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5e433b3b-9dee-4892-8ef3-37cb85ecc7c0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "da497225-c946-4f7a-8403-67d06966f71e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-26T11:24:55.6240976+00:00",
"db_currency_id": "37b50e30-599e-4b4b-a639-27bba5f506cd",
"db_currency_code": "sample string 10"
},
"company_type_id": "f413269f-5854-46df-b87e-502f88a17e84",
"company_type_name": "sample string 32",
"company_type": {
"id": "ec5cbe8a-b38b-4a17-be2f-c2e192415355",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d2452f27-8bbe-44ee-aa9f-653d2dc124b6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c9de66e4-8a75-4544-a275-6893ef8b1b2c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "011d5069-dcdf-4398-897b-7d2726176a6f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f249c81f-f6a6-4d4d-bcfe-a15683da2fa9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "616becd4-e085-4663-b970-724e83a40546",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-26T11:24:55.6240976+00:00"
},
"company_sector_id": "85deaea1-c6a8-4f55-9368-2b648103104c",
"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": "87ba780a-ff40-4230-97f1-46cde56e4196",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3c903f9d-ec1f-4591-9554-e9837ca7beb9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bdc456dc-4c24-4038-a80e-7b97b9af6c9e",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ce614e7-bcb2-4354-bc58-1f07e9e328ff",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-26T11:24:55.6240976+00:00",
"id2": 60
},
"db_language_id": "eb3d8867-5229-43ec-a9b9-0593c5bef4be",
"db_language_code": "sample string 7",
"db_title_id": "6d353328-2e94-4570-bbc4-effa883e797e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-26T11:24:55.6240976+00:00",
"create_date": "2025-06-26T11:24:55.6240976+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-06-26T11:24:55.6240976+00:00"
}