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": "c4ed9efd-e05b-40bf-a490-a788f69f2b97",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "663beee8-ef9a-4bcf-9761-ecccaf3227b4",
"company_code": "sample string 5",
"company": {
"id": "6e3c38de-304c-42ea-8215-20b78e154d2d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T12:22:35.2879071+00:00",
"sales_territory_id": "ddb78b9e-b9a9-4ee1-9918-afa9da6cb87c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "80b87389-ea2e-4b51-8e81-7dd779631f5b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1bb3c6c5-f280-43f9-af4a-c0a52f336591",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "245def53-9b21-41b8-b598-3afa0fa42259",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b409e97-a954-41dd-b220-8306dcbe462a",
"db_currency_id": "dab3f712-7bc4-407d-9209-ce0be281331d",
"db_language_id": "d4b0943b-ae4f-43eb-87f0-18d10a487ed0",
"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-04-18T12:22:35.2879071+00:00"
},
"modified_dateutc": "2026-04-18T12:22:35.2879071+00:00"
},
"marketing_segment_id": "c10eba5f-4e54-4062-995f-a12b0ae7583b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9f67776a-0ca6-4567-8d85-df30a2f93ed8",
"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": "6ed88eab-e3ee-49e9-af71-a15713ba2235",
"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": "2c302ebe-2d70-4e21-b259-4b5867aea466",
"db_country_code": "sample string 28",
"feelist_id": "f15a0775-abf3-4b5d-87c5-96f5ed1c1d72",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1741bf2b-17f7-4e48-9835-e98f9b8e5bfc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "69cc34c4-d5c5-4a64-992e-ab568f2c3814",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T12:22:35.2879071+00:00",
"db_currency_id": "aafde929-7b88-4833-8dd2-d9ecf4ef64bb",
"db_currency_code": "sample string 10"
},
"company_type_id": "eeb6eb26-78cd-4b10-a52f-40215662ea14",
"company_type_name": "sample string 32",
"company_type": {
"id": "971bc79e-13f0-4996-8578-1da5528979c1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "80009235-1f83-4ed5-b154-d7b80a4dd305",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f89a363f-9d8e-4c17-9bea-b214345a83ef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0181b9c3-ec50-462f-9fc9-8ad4436556a8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3b6a93dc-2856-40bc-8cce-0acdbe729048",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f0c3545c-e87b-417b-960d-06e8c96dd995",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T12:22:35.2879071+00:00"
},
"company_sector_id": "4b8eb8a7-f6d8-4f79-a302-692fc667b440",
"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": "6d321633-f1d8-4c6d-836d-98f37239c652",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b9774a47-44b0-4591-8f35-f47af1eeaa24",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "78f13db1-b897-4a36-8903-6766c380ce13",
"account_manager_user_code": "sample string 56",
"company_status_id": "e6777344-cdce-45f2-98e0-4d487715d4bb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T12:22:35.2879071+00:00",
"id2": 60
},
"db_language_id": "3f3a3d32-61a1-4d1e-a236-95d33d2999fd",
"db_language_code": "sample string 7",
"db_title_id": "6c58dd7a-3e33-4a51-b303-ac1ddbc8ba0e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T12:22:35.2879071+00:00",
"create_date": "2026-04-18T12:22:35.2879071+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-04-18T12:22:35.2879071+00:00"
}