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": "cf963af9-7ed6-44e8-850b-a2fe47fb54ce",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cd794306-4809-4bb7-9ddc-034c0b5eac71",
"company_code": "sample string 5",
"company": {
"id": "9306ab1c-396a-4c69-b241-2f498984c550",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-01T05:24:49.7180439+00:00",
"sales_territory_id": "59b8b371-bb04-49ae-bcff-e539440128bd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e4221b4f-ccb9-4377-b7e1-064d5fb7ae92",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb0a303b-07f1-405f-ad8f-89fe1f7f7749",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e8ad6f2d-8d2d-4c82-944d-61430dce6a44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fbb8f915-b05a-431a-94d7-2c6a844330b2",
"db_currency_id": "249e9f78-0b69-4cfd-9359-fd6b5baa6ff2",
"db_language_id": "db9b5deb-de4d-403c-a464-c9abf48d5770",
"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-10-01T05:24:49.7180439+00:00"
},
"modified_dateutc": "2025-10-01T05:24:49.7180439+00:00"
},
"marketing_segment_id": "dd24fec9-d598-4626-ac5f-5ff2adbbb85e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3eb7663b-110f-450b-8006-193c5dd2154d",
"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": "ac79a670-fd2b-4d19-bf00-7db6f36334dc",
"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": "9a4c5873-f7c2-47d2-b109-caa46724897e",
"db_country_code": "sample string 28",
"feelist_id": "2570f3d4-7bba-4484-b120-2f78f7b41d35",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5a213c13-7d0d-4161-855e-3a2984056c38",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e176661d-cf73-4fd6-9c24-3ab5457f899d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-01T05:24:49.7180439+00:00",
"db_currency_id": "49172eaa-b386-448a-aef4-ce4315b348ef",
"db_currency_code": "sample string 10"
},
"company_type_id": "a788b126-8e77-451c-98f5-463c157fecab",
"company_type_name": "sample string 32",
"company_type": {
"id": "14fdf68f-62c6-46ad-a04a-c5713fe2aa1e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "45a60bb7-afe8-49da-b213-c6713eb7b6a9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d6dc3989-6ec7-44b6-8027-be509f4ab9fb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d5480be3-9de1-44bd-b55d-0149565a9c9b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "921b8edd-6165-4222-a860-95f482d6dbab",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c717401e-3971-4dd1-9eea-191e4ab04ea8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-01T05:24:49.7180439+00:00"
},
"company_sector_id": "59eb77d0-527f-4ed3-9d91-cf7928d7e531",
"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": "5bdc78ac-def7-4068-b0a9-f50a27196be8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b45be6aa-7cf5-49e6-8b8a-8335958ea3d5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d93fd454-650e-43d8-93fa-caacab6c9c99",
"account_manager_user_code": "sample string 56",
"company_status_id": "51716ef4-13be-4344-9550-118ad95b1c09",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-01T05:24:49.7180439+00:00",
"id2": 60
},
"db_language_id": "5eac0b69-eaa3-4f5a-83ec-f2f8d3033ab6",
"db_language_code": "sample string 7",
"db_title_id": "bc1aff66-6a28-4909-b040-f936c43f2ab2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-01T05:24:49.7180439+00:00",
"create_date": "2025-10-01T05:24:49.7180439+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-10-01T05:24:49.7180439+00:00"
}