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": "e4a2bf78-d5ba-4f82-abb1-875a09735c8f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "68316a9c-b581-4481-9e91-d9e1e97ab3cd",
"company_code": "sample string 5",
"company": {
"id": "c29105d5-e371-4b87-b4be-e34cec924dab",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-14T11:39:33.0360662+00:00",
"sales_territory_id": "1663b41c-20de-4c31-b92a-23ebad08ba4a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8f09e911-c688-4e19-8250-8bf2b51850e8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c3dee15b-eac6-43a9-baf5-ebf43b22a051",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a10dc08a-eacd-41af-a646-6273ba917716",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81fda49b-844a-43f2-a0ce-726bb7e4bc38",
"db_currency_id": "bbaa2f0e-d7bb-4350-bfcf-3963ee9ff304",
"db_language_id": "e267ad47-fad0-4dc3-808b-418a5a49efaf",
"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-01-14T11:39:33.0360662+00:00"
},
"modified_dateutc": "2026-01-14T11:39:33.0360662+00:00"
},
"marketing_segment_id": "f5339023-e585-4598-b85c-c7963c946fa3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4c77f32a-f199-497f-83c6-0b1099e5cc31",
"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": "cb63db3b-11b9-4b43-8ba9-15a0e74c6fd6",
"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": "78d30b06-e1b2-4641-9097-d53488613f6f",
"db_country_code": "sample string 28",
"feelist_id": "c1043e88-a8a8-42ce-a3ba-108fd54f29b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4ae63e48-c547-47d2-9ecb-3fef6ec5c1fe",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "57565977-3c0c-4c77-b119-3b77a9772a02",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-14T11:39:33.0360662+00:00",
"db_currency_id": "02fb2866-f28f-44fd-9aa7-f92a96d03e47",
"db_currency_code": "sample string 10"
},
"company_type_id": "1d82fcab-cc87-46ff-bde7-33262e22839b",
"company_type_name": "sample string 32",
"company_type": {
"id": "8083be35-139f-414c-9ae6-47d3dcd9fba4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e386aa8-f741-443b-b3af-fabe09b6f4ce",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d017d14c-7505-4fe9-aa5b-3ab3b1f0d4ea",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "93521d79-e97f-47ed-b97a-1dfcd5f9c077",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7015a236-2538-45fa-ae0f-71fcd77ce330",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eaf9243e-c703-468a-90f9-4eb40f58ba63",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-14T11:39:33.0360662+00:00"
},
"company_sector_id": "68e5973d-8b85-446e-bd2e-5d066d7532c8",
"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": "a2b11ca8-1e64-4aff-84c9-50befe310177",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8fcead0f-0faf-4ffa-a6ec-3f8ffa2f082a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4a43d8a5-b31c-4a2b-bb58-68f4fdfdacf7",
"account_manager_user_code": "sample string 56",
"company_status_id": "bd9d67c5-5234-4cad-b35a-ca685ff52f64",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-14T11:39:33.0360662+00:00",
"id2": 60
},
"db_language_id": "947a559b-214d-4299-b02b-5239dfa4fb56",
"db_language_code": "sample string 7",
"db_title_id": "f8616019-42f4-4381-8ad1-751ca9711908",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-14T11:39:33.0360662+00:00",
"create_date": "2026-01-14T11:39:33.0360662+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-01-14T11:39:33.0360662+00:00"
}