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": "2e868854-ff96-4269-a993-2e1b426733a5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "34fbd1be-a345-4b3d-b815-121182b9f3a3",
"company_code": "sample string 5",
"company": {
"id": "6d19fa3a-5cda-4afa-be4b-901bc199ad2b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-21T22:35:40.9082476+00:00",
"sales_territory_id": "31a0da58-4dca-4bec-9ebf-ab39cd3d0da9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "871f898e-0963-4ba6-9f0c-14c5d8e6ba20",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6652dc80-d026-44d1-a042-eac500f5fc61",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed38702c-7134-4852-ae97-e1ee9052da8c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be603e90-8af4-4cfa-b7f5-12c8428367e6",
"db_currency_id": "af7d95d1-81b5-474c-930f-f1fe00453298",
"db_language_id": "3a21cece-6c67-48ac-ad5f-0f0851ff930e",
"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-06-21T22:35:40.9082476+00:00"
},
"modified_dateutc": "2026-06-21T22:35:40.9082476+00:00"
},
"marketing_segment_id": "dc131b11-18da-43a6-b0b2-30d9fe00cd63",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "23bf900f-e130-43b6-9f40-d5e816d825ea",
"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": "6054b26f-d7b2-45e1-8b30-de28c6ec58c0",
"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": "b21a76c7-a10e-48a1-b12c-f29268e98c1f",
"db_country_code": "sample string 28",
"feelist_id": "c82a0182-5c9b-4d85-a1c0-16baea8a8d2b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b9d9d2ae-df7e-4370-8aaa-a82317c51180",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f1dc8a7c-5dac-4ad9-96b0-c5d19ca43a37",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-21T22:35:40.9082476+00:00",
"db_currency_id": "0ff5977f-f6ad-4dd6-8289-13cd40396f7f",
"db_currency_code": "sample string 10"
},
"company_type_id": "7f40e105-a7f6-44b4-a0ac-a088ebdb3ce7",
"company_type_name": "sample string 32",
"company_type": {
"id": "a5becc5d-c739-4689-8b13-31967012c7cc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ce8f8912-b492-4bae-9447-db376ec231bb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "134260bf-8859-4f9b-8f4f-7c29fe93b726",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c488484a-a391-4e57-bb32-b4ba183cb744",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1e597ce5-0b51-4546-843f-332bb594200e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6e2b6d73-40ec-43be-8655-d8fcf7fc65be",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-21T22:35:40.9082476+00:00"
},
"company_sector_id": "d15f8e8b-f720-4d44-bd24-627ea731e160",
"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": "e5885f78-fe34-46d1-a672-b3b6a21be41d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dccca52a-3195-483a-8454-b70022c3d593",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8f65ea4f-affd-41b2-88ba-3b78b3e81d28",
"account_manager_user_code": "sample string 56",
"company_status_id": "1bcfaa60-b8da-4b66-9f4a-dfbe6a555671",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-21T22:35:40.9082476+00:00",
"id2": 60
},
"db_language_id": "f29195e7-7772-494d-bac8-36f9a5439bbc",
"db_language_code": "sample string 7",
"db_title_id": "2ae52ccc-baaf-4ffc-bcca-247fc8a85c25",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-21T22:35:40.9082476+00:00",
"create_date": "2026-06-21T22:35:40.9082476+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-06-21T22:35:40.9082476+00:00"
}