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": "4fbe849f-5617-40ee-9628-895aa863ef04",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "35c35f6d-8af0-461f-8693-e17ba7e99274",
"company_code": "sample string 5",
"company": {
"id": "03250667-28e3-489c-b21a-42f3a4942c88",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-26T09:13:33.8725183+00:00",
"sales_territory_id": "b5fcee02-cc68-4eae-881f-779bc825807b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ff7b7770-3f76-4c57-9f88-e0449a2bcf48",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "64dbd183-4cd9-4509-a48d-d5aa7bdbde5a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "287ba240-2b32-45a2-b086-2eeb351735d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37956a1a-e8bb-4c7a-823e-c00667ea757b",
"db_currency_id": "d8085c8c-0fa4-4e81-8e58-6a2dcc9f04e2",
"db_language_id": "83dca10b-2d9b-447c-aa67-3f594cee4d28",
"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": "2025-11-26T09:13:33.8725183+00:00"
},
"modified_dateutc": "2025-11-26T09:13:33.8725183+00:00"
},
"marketing_segment_id": "9c877394-8dbe-484e-8355-2f8510eb950f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e14ea3e3-ccdd-40a7-8c9a-bf05fe6bdd53",
"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": "3f8d49a6-43e6-4efd-80df-2a116a3d8b49",
"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": "c969b2cc-726a-4b98-9de3-c3afe60aa7d8",
"db_country_code": "sample string 28",
"feelist_id": "e07ab657-05fe-41e6-a9e7-ba2bb71a397f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "117fa372-05c0-4aa5-9e6d-552810b4ede4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9b819e4e-21ff-4566-a58d-f1ad7c1d5c00",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-26T09:13:33.8725183+00:00",
"db_currency_id": "845ca5a4-2cb9-40a1-be17-4a8b51fc452f",
"db_currency_code": "sample string 10"
},
"company_type_id": "66de5d16-9f07-4e63-b670-c10821039e2f",
"company_type_name": "sample string 32",
"company_type": {
"id": "574cb251-ebb9-4298-b691-50e55d34d912",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2956b1ee-668e-4adb-9bd5-5a75b832cc83",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9b364226-f16a-401c-90f5-43ae67da5aa5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "139ee849-43fa-4e9f-a5ab-4f6733a0784f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f0202d0c-5b65-455f-8f95-fff06447f8c1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "69f7b4cc-654f-4562-8c55-5debfa81ddfa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-26T09:13:33.8725183+00:00"
},
"company_sector_id": "bf1cbc17-cdce-4513-9f39-f8e9e70d54e6",
"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": "d03a118b-9fbf-4e7a-bda9-ed30ceee7d97",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d5b7cc8-3be4-4a37-837d-0310bb8b5c13",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4102699e-ca1b-4c58-965f-815bf0c8bd59",
"account_manager_user_code": "sample string 56",
"company_status_id": "1aa27a1d-7aba-4714-9992-4a3965b06005",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-26T09:13:33.8725183+00:00",
"id2": 60
},
"db_language_id": "f4726538-2ace-4835-a3c8-e1b5e934b6fc",
"db_language_code": "sample string 7",
"db_title_id": "108913e7-2861-4129-93b6-951cb27f0b6c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-26T09:13:33.8725183+00:00",
"create_date": "2025-11-26T09:13:33.8725183+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": "2025-11-26T09:13:33.8725183+00:00"
}