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": "a55f300b-5200-4013-8fda-ec527f7187de",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "34fb452e-767a-4d9b-a71f-46cd9844bf04",
"company_code": "sample string 5",
"company": {
"id": "5aac27fe-12a3-47da-a709-6429fa2f142d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-21T02:20:06.1861173+00:00",
"sales_territory_id": "a339d139-ee7d-4c2d-a865-5632d5d80536",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d186557a-0cef-415b-aa39-51bd3377e561",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "12ce0b02-892b-49df-b32c-cf6954b5d11b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0188c4a8-b157-4c44-bd84-bc2121d7ea53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1605cf4-bcd6-450a-b9b5-5be2b77f72ca",
"db_currency_id": "7f696ab5-a9fb-41d0-b01b-384776748bef",
"db_language_id": "92f5f405-2666-44cb-b265-4a9d3df1f834",
"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-08-21T02:20:06.1861173+00:00"
},
"modified_dateutc": "2026-08-21T02:20:06.1861173+00:00"
},
"marketing_segment_id": "47b4bbed-23a2-470c-969d-8e57f0df9804",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e31f9bd7-d21d-45a5-9502-4992f0a7617f",
"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": "db254ad9-dd0e-4733-922c-b46939bf06e3",
"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": "8db9d432-6593-45a8-ab09-a7a3c824c9fe",
"db_country_code": "sample string 28",
"feelist_id": "28438a82-7152-4175-94de-70443422c58f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "782366aa-24e1-4af9-b72b-79c6ea8e3878",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7da85de1-063b-42c7-be1b-ae0accc71afc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-21T02:20:06.1861173+00:00",
"db_currency_id": "1ccf6b36-a258-48c7-aa11-a4a80e771c7b",
"db_currency_code": "sample string 10"
},
"company_type_id": "04352bbf-3da9-4290-a9c8-73299b73646d",
"company_type_name": "sample string 32",
"company_type": {
"id": "a8c59b0f-8195-4d50-a7c7-c454c02b69c3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d116966-454e-4498-b5b4-c52c011794ee",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d4f1a278-4c4f-489b-bd86-4c0f31903a47",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a29c29ce-2fc8-488e-a06f-4743b2ee5f7b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "18493d94-b4fa-4d7b-9440-5f2635840369",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "be5a5457-c8a9-4a48-b8fc-55fd2eade515",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-21T02:20:06.1861173+00:00"
},
"company_sector_id": "8edbc60d-3707-4ac1-ac2a-67f0b9622a92",
"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": "122accd3-8322-4b73-afa3-f7b2a8175bad",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4e47ec70-5892-4685-bb43-5cbd5278e8df",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "36496987-d711-40cf-aa7a-b16dd0790e57",
"account_manager_user_code": "sample string 56",
"company_status_id": "8c0698cb-cbba-40c0-a4dd-1450fd010285",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-21T02:20:06.1861173+00:00",
"id2": 60
},
"db_language_id": "ae188f51-efe5-459c-b8fd-e03d769bf846",
"db_language_code": "sample string 7",
"db_title_id": "96addd6d-c847-4343-8a3e-6acff605c6f9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-21T02:20:06.1861173+00:00",
"create_date": "2026-08-21T02:20:06.1861173+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-08-21T02:20:06.1861173+00:00"
}