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": "019ea7f5-1d1d-4759-976a-ad87ab96638b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5b2381fb-e8cf-4b10-b9ad-329d370f18f3",
"company_code": "sample string 5",
"company": {
"id": "8adb07d2-0848-4e12-9c7f-8ad846830a7b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-25T02:38:03.615631+00:00",
"sales_territory_id": "44112312-81c4-468e-aafd-5ea9c449ae55",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "38337d1b-c7c5-4b98-be52-82ea708010a9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9900e53e-1117-4615-a705-640ead67f58d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3e5ba363-6751-48b7-9c69-00e208a3064a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf0f9fb6-4afb-417c-861c-f1f0aaae211f",
"db_currency_id": "124db1a9-535e-4e4e-9054-99755bc2bf92",
"db_language_id": "e73d237e-2215-4610-8f64-31232191628b",
"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-05-25T02:38:03.615631+00:00"
},
"modified_dateutc": "2026-05-25T02:38:03.615631+00:00"
},
"marketing_segment_id": "63a7c461-9d45-4deb-8aeb-c4c260277af1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "84e13189-b99e-45e4-8fb4-3b5b1b21d919",
"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": "a614b7b2-5596-4cc3-af94-6ffe5f1bb9de",
"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": "889bc29f-28a9-413a-bbd7-224333c5cc32",
"db_country_code": "sample string 28",
"feelist_id": "3a76ac49-4ada-42b7-8272-a3e353541abb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f34d9465-7d60-4bda-a4d7-0d146527614b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e0537062-8bea-472e-8842-f9a68f35a1f3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-25T02:38:03.615631+00:00",
"db_currency_id": "d434a653-21ac-461d-adc6-3b7150682b12",
"db_currency_code": "sample string 10"
},
"company_type_id": "4d182626-cf3d-4b99-a6a4-330c98576bfe",
"company_type_name": "sample string 32",
"company_type": {
"id": "b6d2eaf3-c017-4362-a1ab-02eaeb357762",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b84b2b04-9b8b-4fa8-8521-11c3ac2d77b4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5d740646-ccc4-4e34-9fc0-e14ae9ae960b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1adeaa8f-1507-4707-872e-0bb737e14df5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "330983d1-1b0e-4d22-8647-7b1b0aaf4150",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8a34b2a7-5058-4710-99e2-1026018b7a84",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-25T02:38:03.615631+00:00"
},
"company_sector_id": "411b2dd2-93f3-473f-9ead-e0048621bf73",
"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": "401af9e0-f761-490d-a408-efa9f3051f66",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f7a4ea3c-b13d-43d9-bf25-ad1075abe6ac",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f5d1c320-20fa-4de3-9bae-03f5db22aa4f",
"account_manager_user_code": "sample string 56",
"company_status_id": "5119ab10-8faf-4736-8353-f998b96ac845",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-25T02:38:03.615631+00:00",
"id2": 60
},
"db_language_id": "d151f143-ba31-42f7-9a82-83f6e86035bd",
"db_language_code": "sample string 7",
"db_title_id": "1453ac99-0fd3-4d9f-93af-7bd8c1de79ee",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-25T02:38:03.615631+00:00",
"create_date": "2026-05-25T02:38:03.615631+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-05-25T02:38:03.615631+00:00"
}