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": "03fc81be-29d0-4102-905b-523f31253530",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3b792f98-cb5d-4d75-b6ee-aecbe28e50f4",
"company_code": "sample string 5",
"company": {
"id": "ed1e8068-d857-4132-b8f9-b3ea92aeb903",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-06T01:10:36.3908408+00:00",
"sales_territory_id": "100e6b07-11c4-4536-9f84-26c61fff3410",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "22eb12bc-818a-4732-9149-eb1df8e187d9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3431ea2b-b2d2-4862-abbb-e6b9ca40c31b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "efb1a692-564b-4ed5-9f9b-e3d3876c71f4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec01dd3e-544b-40db-a25a-40935a8ee67c",
"db_currency_id": "ca05b618-b1f0-4f13-b55b-53d73f20eca5",
"db_language_id": "f976a3b8-afe9-42c6-95f7-b70361f71bf6",
"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-02-06T01:10:36.3908408+00:00"
},
"modified_dateutc": "2026-02-06T01:10:36.3908408+00:00"
},
"marketing_segment_id": "d27416f0-b8fc-4a93-a2da-62764cc623fc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "93d001fd-2194-4038-90e0-28b36fb980ff",
"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": "b3e09714-d328-4996-80ca-89c30ceecdcc",
"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": "e5547148-dd11-4b87-9186-a7234bef4caf",
"db_country_code": "sample string 28",
"feelist_id": "207312d8-cc32-4da5-9fb0-340f87ce9ac9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1fa7a09a-62dc-4181-8ea8-320d3bc8cdb1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "13099cf1-c85e-4a8d-8964-3a067f487bc5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-06T01:10:36.3908408+00:00",
"db_currency_id": "4c12670c-0151-4148-829c-37c3ca5b222e",
"db_currency_code": "sample string 10"
},
"company_type_id": "fd85d485-077a-4cf8-a43c-376cb5a5075e",
"company_type_name": "sample string 32",
"company_type": {
"id": "2dac2336-75e2-4899-9617-be326bdf1c52",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "266648dd-9bae-4e1d-821d-6dd339e03624",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1fb2a2b0-aaf8-4d5c-a98a-ab9d449ab3bc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f218316a-d56c-4305-9bad-a0b6f9e1ada0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "818dce6b-8315-4bfc-b715-c6b1b7c442ee",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9dbc630b-4025-48e3-87ef-f0e97754461a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-06T01:10:36.3908408+00:00"
},
"company_sector_id": "2881fc07-42a2-49f5-ae29-fb6e2644f526",
"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": "75ef41b4-1343-484a-998f-d76c4a061e25",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c3413615-9324-4c72-8684-f5e8d4f30620",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db1928ea-2885-40c7-8ebe-5fbfd583de9f",
"account_manager_user_code": "sample string 56",
"company_status_id": "00210792-2948-4ca9-adb3-8047a906810d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-06T01:10:36.3908408+00:00",
"id2": 60
},
"db_language_id": "40953d89-5493-4b53-89ec-ed7e106dee0e",
"db_language_code": "sample string 7",
"db_title_id": "dcc12a4b-1feb-4a81-9001-fbafe7e691f3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-06T01:10:36.3908408+00:00",
"create_date": "2026-02-06T01:10:36.3908408+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-02-06T01:10:36.3908408+00:00"
}