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": "077d1b09-006a-474b-a79c-e7dcbb9cc865",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eca0ab3c-3cc2-4538-b882-63ba2ecb52f4",
"company_code": "sample string 5",
"company": {
"id": "fe2e8f7d-b0f0-49fb-bcfa-3dee9ef69302",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-22T08:18:49.0638783+00:00",
"sales_territory_id": "557db336-e2c5-49da-9d25-9c61f722b0c1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9315458d-5ed5-4d96-9198-791ad0548f0b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fdac49ad-8755-41b1-8c6c-c7a221b3195b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6fb1ee66-4654-4d09-9cba-293a5d496b76",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "16ce08d3-ca02-416e-9871-3e5c50aa603d",
"db_currency_id": "a55ae4d4-90c0-4130-8dd5-be39ef1d91ac",
"db_language_id": "ddb40146-890d-459b-8ae1-28c77b2b6a46",
"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-10-22T08:18:49.0638783+00:00"
},
"modified_dateutc": "2026-10-22T08:18:49.0638783+00:00"
},
"marketing_segment_id": "ed5350ea-02d5-4877-95b8-5901d1abd822",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "eea55ed1-d3ef-47bc-947c-ddf5adb003eb",
"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": "a764f93e-73e4-4fc5-9dcb-91129893aac8",
"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": "5794bc58-49b2-452f-98fb-0eddc3c86f3c",
"db_country_code": "sample string 28",
"feelist_id": "b1d3b9cc-77ba-493d-9c86-b998c42c6978",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9967fa7f-82c7-46bb-a3fd-72bccaf11be1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "07837de2-22a2-4009-a4bc-164bc5885341",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-22T08:18:49.0638783+00:00",
"db_currency_id": "24abf30f-59e4-49a6-83fb-e876418ad911",
"db_currency_code": "sample string 10"
},
"company_type_id": "ea54142d-26c8-4e57-a70f-2c5758634d11",
"company_type_name": "sample string 32",
"company_type": {
"id": "19f6f79d-c08a-4082-9cce-ced8093890ec",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0b17d28d-0d75-4bf5-aeb9-ffc6830cebf6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2a2aa2ed-4730-4d2d-bf9a-61b9e4745b40",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "832ee60b-a4c3-4c1a-aa2b-81895389324b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9375ad74-4ffb-4980-98c4-afa794fec2f7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "48eeffc2-ada1-4955-a0e5-b81f2b566cde",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-22T08:18:49.0638783+00:00"
},
"company_sector_id": "fa47763f-afee-45cc-99c7-c97d4d05f24e",
"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": "0d850b80-a34f-4276-85d4-16c8dc7647e3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "920c81b5-62c0-4abc-acfa-ff13d361ca59",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4023187c-8a28-488d-a720-1e143d04e62b",
"account_manager_user_code": "sample string 56",
"company_status_id": "0cc2436c-b834-4802-8e96-62adebed4d5d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-22T08:18:49.0638783+00:00",
"id2": 60
},
"db_language_id": "aa220139-4e35-4c96-8b56-622b6e96035f",
"db_language_code": "sample string 7",
"db_title_id": "ef85de8d-348e-4f11-87ff-9e91a81b69a3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-22T08:18:49.0638783+00:00",
"create_date": "2026-10-22T08:18:49.0638783+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-10-22T08:18:49.0638783+00:00"
}