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": "c8a40fce-75bd-4009-af62-03277ef0d597",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0feda2df-1fdd-4e5f-bf9c-7040a197444d",
"company_code": "sample string 5",
"company": {
"id": "986af71e-a487-4544-91ac-e406b3728111",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-24T15:00:09.8767251+00:00",
"sales_territory_id": "07032fde-b42a-44c9-9cfc-5f36f3a157eb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dc475eda-b626-486d-94d7-cd6f3d651b07",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f5fbda95-461a-4ecf-b8ae-6210d2cb01c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6c2d0ed2-4593-4469-8182-6d75b8839030",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca799b15-74b3-4daa-86d2-12b8e6cc1734",
"db_currency_id": "ec80c139-80b5-4325-8fbc-441f73aba05d",
"db_language_id": "d3a635fc-4a53-4cbc-93fb-89cc2a728d57",
"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-01-24T15:00:09.8767251+00:00"
},
"modified_dateutc": "2026-01-24T15:00:09.8767251+00:00"
},
"marketing_segment_id": "69f9edfb-8599-4926-9fb7-abee0860b529",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6a731b59-aa3d-4f6f-ab32-3a4e36e38d5e",
"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": "1686fc84-4ba8-4853-b6cc-af245ea595a4",
"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": "b3703ccc-64eb-46d2-a2e3-b639e7428d70",
"db_country_code": "sample string 28",
"feelist_id": "6d87ffbf-b6f4-4789-9103-fdc2863fcf00",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d60eac0c-8ab9-4c91-8db4-c9a77b66da0d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "10186d91-63da-4e96-b2ce-1256dfcc64a4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-24T15:00:09.8767251+00:00",
"db_currency_id": "5a11971b-3834-4bee-93a4-6ab42a139af9",
"db_currency_code": "sample string 10"
},
"company_type_id": "93cbbea7-7fc4-4fa2-9c07-af4984b0b4d9",
"company_type_name": "sample string 32",
"company_type": {
"id": "7bd12c7e-8629-4ae8-a8ce-a350bc2bc21c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f2b66a4-3906-46dc-af04-61afb616cd2f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "107d48b3-a9d0-41e6-87c6-dc0c6dff1fc5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f1edb512-232c-4beb-b671-a422a4235e06",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "41e13029-1d87-42e6-9518-5ab4c78b08ef",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7f2831ae-8be5-48f1-b8ba-19acf3a59faa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-24T15:00:09.8767251+00:00"
},
"company_sector_id": "775f11ad-655b-42a2-a95d-7d188acb3845",
"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": "9e58bd32-f910-4ec0-a375-0568d71a59b4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cf9774de-8e0f-4e41-8740-abaeb2bf43af",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "33ae7ecd-6636-4b6e-bf41-d78df00e511b",
"account_manager_user_code": "sample string 56",
"company_status_id": "a9f225c8-bbb2-4713-8f21-aaf695226a27",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-24T15:00:09.8767251+00:00",
"id2": 60
},
"db_language_id": "cfd02e69-5545-45a9-812f-e1909006e1be",
"db_language_code": "sample string 7",
"db_title_id": "f4188249-26b5-4884-9f75-aa68f2a5cea5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-24T15:00:09.8767251+00:00",
"create_date": "2026-01-24T15:00:09.8767251+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-01-24T15:00:09.8767251+00:00"
}