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": "14435b94-e390-4751-936b-2dfc2299307e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e040eb08-507e-48fc-a610-5ff97b0bd00a",
"company_code": "sample string 5",
"company": {
"id": "2b97331d-b8c5-4574-bab3-7173e8bc32f6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-12T00:03:55.2901505+00:00",
"sales_territory_id": "dbc0cccb-574d-4c6d-91c3-8a1bc6b91a3a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "24364ef5-494d-4d63-9115-4fff996a204f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "427e65a7-e589-4ae6-b1f1-31ec4ef083d2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d4071f3-8d37-4fbe-939a-5377a79be28b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e59e4a02-22f7-42b9-94d6-acd5c0f28e6a",
"db_currency_id": "00d6a0e0-06a2-45e0-8130-74cf870a8aee",
"db_language_id": "a61c51c0-b275-4566-9582-c9164a1c50a3",
"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-07-12T00:03:55.2901505+00:00"
},
"modified_dateutc": "2026-07-12T00:03:55.2901505+00:00"
},
"marketing_segment_id": "1983cc2f-50db-49e3-aa14-3a85bc326442",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7eb94f80-4cda-40f7-90a6-19a884d1d00f",
"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": "c3586e2d-f8b8-41b1-ae1f-cb077419dcae",
"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": "e6b88078-f6ca-4add-9863-cbd966bbba02",
"db_country_code": "sample string 28",
"feelist_id": "567c56e3-7abd-4ce8-9c6b-cdc1be448ee2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d06a233c-f6dc-48a9-99dd-83ca202e39e8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5bb84ae6-f0b3-4f78-adde-42d4da02d7cc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-12T00:03:55.2901505+00:00",
"db_currency_id": "cccb884c-72a4-4b5b-ad83-382d81c3e8f5",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2b26457-3507-4391-946d-8fa944ab7195",
"company_type_name": "sample string 32",
"company_type": {
"id": "8ffc4acc-6bd7-411c-9af7-2b9b1e66f595",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "75162cb2-c0eb-4132-9697-722f5c57b52b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9963f812-f306-416e-9360-d0cecb4bc435",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62cea636-2998-44f3-a113-e1c6070044af",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "00ad080b-b3c7-4696-aeef-ef63907dd049",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4038eba9-94f6-4a26-95de-f45fe59b84db",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-12T00:03:55.2901505+00:00"
},
"company_sector_id": "7aba86cb-3c33-4ce9-a0ba-431e1ef2f7e3",
"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": "568f35a0-84ea-4cf5-920b-af97c6f7a53a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "57116786-ce32-43f1-bc57-e07cbc6bc693",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ec398e7d-6cc8-40f7-85fd-442a0f7c96d6",
"account_manager_user_code": "sample string 56",
"company_status_id": "451e8893-9ae6-4b46-bbaa-5af4e396c304",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-12T00:03:55.2901505+00:00",
"id2": 60
},
"db_language_id": "2c550ead-c644-4753-87bf-5e688d0c330f",
"db_language_code": "sample string 7",
"db_title_id": "1746182c-1bd7-4d1f-b5e8-fdecc5dbeef5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-12T00:03:55.2901505+00:00",
"create_date": "2026-07-12T00:03:55.2901505+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-07-12T00:03:55.2901505+00:00"
}