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": "a04c71bc-9f7a-46cc-8f31-a65592f0e5ea",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5d65f9b8-ff05-467e-8d27-c7bc46164a53",
"company_code": "sample string 5",
"company": {
"id": "a491fc60-94f6-41af-9294-cd872c27064b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-10T19:58:09.4342806+00:00",
"sales_territory_id": "34452e0a-d98f-4b05-82ad-51cbee370180",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ab348913-2db6-4c70-a2a2-4b7fd4da4179",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "12b499dd-e152-4137-8a62-69e3b4ce2d68",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0317e5aa-13a0-4634-8d0e-0714b26f40e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8c34e40-061f-4516-a5d6-8ae134664948",
"db_currency_id": "87efa413-49f5-45e7-a30f-8894751e2509",
"db_language_id": "0d023fe0-de15-4bc3-9769-f7a367614df3",
"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-10T19:58:09.4342806+00:00"
},
"modified_dateutc": "2025-11-10T19:58:09.4342806+00:00"
},
"marketing_segment_id": "c951b491-1fe7-48c3-bb8e-3ea46b865fe6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bb1bed2c-5a46-4a7b-b398-e4ca63566271",
"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": "9d869a29-e28d-427c-a986-7b21209669c9",
"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": "6e07d691-9967-4b9a-b302-233a22735526",
"db_country_code": "sample string 28",
"feelist_id": "5488add6-847b-4c63-8608-472c28065443",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8de6505b-533e-493c-9954-b4b519263e5d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f3afe346-cea9-4646-b048-c6df53bc14ae",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-10T19:58:09.4342806+00:00",
"db_currency_id": "85f646e4-05d8-4cfa-9805-e659a8cd176e",
"db_currency_code": "sample string 10"
},
"company_type_id": "cf927c79-e406-4551-963f-3ab4b41dcc17",
"company_type_name": "sample string 32",
"company_type": {
"id": "f2700435-4c4a-473d-b341-9e6e65d6b761",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f4100b83-b11e-4689-9c88-93aa6f194abd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f609e8e0-a02c-46b1-91ea-cca3d469de76",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "88d3ed1b-f3f7-4229-84ab-ce7d8127ef61",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c4ab5689-159f-4078-8da9-09d77083595d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "990874db-67bc-44ed-9d9e-a6b74baccdaf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-10T19:58:09.4342806+00:00"
},
"company_sector_id": "4bdf2e70-9539-4e86-9858-634b74c671ad",
"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": "be93c822-3f14-4b99-b27c-6285e023bcee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c0ef06a4-0e13-475f-84da-3c3b6e261d10",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "476a0836-94ce-4903-b103-a49178cf85f0",
"account_manager_user_code": "sample string 56",
"company_status_id": "31e2afcc-a39a-4590-9906-8d21ebe58440",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-10T19:58:09.4342806+00:00",
"id2": 60
},
"db_language_id": "751674bd-4b6e-4c33-9574-dc8506a7ff22",
"db_language_code": "sample string 7",
"db_title_id": "3c3e8735-8a95-4e26-a6bc-5610c436d8ce",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-10T19:58:09.4342806+00:00",
"create_date": "2025-11-10T19:58:09.4342806+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-10T19:58:09.4342806+00:00"
}