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": "262c2730-de03-4edf-ba0e-0e179590bf64",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "009ece71-efa6-4de4-adf2-5c78df6bce22",
"company_code": "sample string 5",
"company": {
"id": "a9d8b39e-fc62-489c-8121-3f1bbaa079bc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-03T04:58:22.3548302+00:00",
"sales_territory_id": "636b9e6a-a2d0-4403-84e1-56a54688a690",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c11287b8-acda-485e-a789-d21e4f91993e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8b7d59b-21a7-411d-b780-9ce3dd434e84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d5e940d-d614-4b41-a323-936d51d01d15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "828ac402-b6e9-49ad-8312-2b90ee87d4a6",
"db_currency_id": "81757052-af38-41cb-a98e-9f4b45cbab9b",
"db_language_id": "04c04652-8f81-44d4-81af-d25bfcff1a78",
"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-03T04:58:22.3548302+00:00"
},
"modified_dateutc": "2026-04-03T04:58:22.3548302+00:00"
},
"marketing_segment_id": "8b4df483-b84c-4d01-b325-ec1fab655c1b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6a43fc69-e890-438f-92db-86a908be0429",
"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": "76edef63-9121-4ec3-bf8a-958b1bc31409",
"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": "8672eb09-0b9f-479b-ba59-00e5daf3bf75",
"db_country_code": "sample string 28",
"feelist_id": "8e1cc796-cc38-4498-ac90-2c4bf5d6e569",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a75e4084-209c-4b42-9cb2-fd43fdadd0b5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9b74ac00-6b61-46c8-ab4e-204bba8b4452",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-03T04:58:22.3548302+00:00",
"db_currency_id": "aa10935e-6324-4562-be6b-2bcc8d5d7a9f",
"db_currency_code": "sample string 10"
},
"company_type_id": "3d17359e-87b8-4f2a-98b3-ea646a6462ca",
"company_type_name": "sample string 32",
"company_type": {
"id": "b2e41fb4-956e-4afd-b046-d68b437d6498",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "361521c8-766f-4597-a5d2-6942cc378c3a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "254b5c8b-5cb1-4f24-bc4e-e2d608b04436",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "08704df4-0246-409d-b77d-fd771ea6d182",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3ae22b80-0594-4653-b0ef-9351efcfc20f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "157c3586-887f-40fd-9239-7ed6107824cb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-03T04:58:22.3548302+00:00"
},
"company_sector_id": "18f79656-5a71-43bc-9ef4-77fef4e004a2",
"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": "8b961d39-aa40-4de1-8bae-23d97256b095",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "76336544-229c-4c5e-9546-141362e01f73",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7f598c6d-cd49-43ae-9cb0-9e7dbd4b907a",
"account_manager_user_code": "sample string 56",
"company_status_id": "0761c14e-c054-4d34-909f-06c0682e229e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-03T04:58:22.3548302+00:00",
"id2": 60
},
"db_language_id": "ffc0f310-d621-4033-9b52-50f0c2e03515",
"db_language_code": "sample string 7",
"db_title_id": "ced2fd1c-ba71-48d6-a73c-d488ab738602",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-03T04:58:22.3548302+00:00",
"create_date": "2026-04-03T04:58:22.3548302+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-03T04:58:22.3548302+00:00"
}