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": "5fff4e69-eb04-4a1f-acfa-88fc1484177b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c14b14d3-346a-49f3-a160-6301a946556d",
"company_code": "sample string 5",
"company": {
"id": "55aadfe5-af86-4879-abc7-9f04bf7f631c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-30T11:01:34.3691656+00:00",
"sales_territory_id": "87e22193-b1fd-44c9-87db-222e8f7be93b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a575e280-83d1-4a06-8a35-dc605d165ed8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "379f7904-3c76-4705-adf2-e335da62d000",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d134282-b3aa-46ce-9bf5-e87e983df5b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f259d004-329e-4c8d-8923-1b0d7209d473",
"db_currency_id": "cedd3af5-1cb4-43d4-8c01-137c9c0e4564",
"db_language_id": "cdde0891-ba7a-4627-9650-14a512ba4a36",
"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-12-30T11:01:34.3691656+00:00"
},
"modified_dateutc": "2025-12-30T11:01:34.3691656+00:00"
},
"marketing_segment_id": "256586ed-ccf0-4722-839d-d5b7e887a86e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2a838e6f-1bda-42a9-93bb-376bee7b79f6",
"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": "6150710c-7b13-46e2-9d97-69de53f4b61d",
"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": "1d5582c5-2aa9-4219-902d-0b169ad71f19",
"db_country_code": "sample string 28",
"feelist_id": "c86df238-763b-4e9a-a3e3-b15dca4b4b66",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "977582a5-56cd-4831-bf93-4be484cc562c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "49a1df18-4e08-443b-83a6-8c40d814e6df",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-30T11:01:34.3691656+00:00",
"db_currency_id": "b9ee0140-2331-4e3f-b26c-cebfddba0f15",
"db_currency_code": "sample string 10"
},
"company_type_id": "50c17048-672f-49b7-9194-b346bed41809",
"company_type_name": "sample string 32",
"company_type": {
"id": "63529158-fe93-41b1-a81e-35ae0a3a1cfa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "190e201e-4d44-4afb-b2f6-3fcf4b3593d8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ae37c2f5-7386-477e-8384-1591955a5cb1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "05f15454-27ac-4731-a081-8ccd0339a227",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "489fc33b-02fe-4bf9-b468-426a2411b1a9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "10e9d6d1-750a-4cd9-b237-87a54c34462d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-30T11:01:34.3691656+00:00"
},
"company_sector_id": "7cc75e3b-a681-400b-ac1c-8fd0cb4db0d1",
"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": "6648db46-be13-4e81-a0eb-faf890674a40",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0d8701d3-d27b-4721-a180-f27675833e5a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "220c2f16-8be9-4661-ba96-e92520007189",
"account_manager_user_code": "sample string 56",
"company_status_id": "1e5e076d-83d1-40db-9812-5cb48629dc77",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-30T11:01:34.3691656+00:00",
"id2": 60
},
"db_language_id": "ce807bec-b658-4023-b04e-715c823347e7",
"db_language_code": "sample string 7",
"db_title_id": "81aea2c2-9271-42aa-bfe7-73486b7be17a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-30T11:01:34.3691656+00:00",
"create_date": "2025-12-30T11:01:34.3691656+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-12-30T11:01:34.3691656+00:00"
}