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": "bc8dbb91-b8ee-4bff-8017-4e5596553ffe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "afe045e1-db3f-4833-a048-5700b1f99c0f",
"company_code": "sample string 5",
"company": {
"id": "42229140-42d7-43d0-9c40-43f0e0055ee4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-04T17:28:07.0097878+00:00",
"sales_territory_id": "56a03526-e76b-46d9-a4d4-7bc28a2c745e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a7a28074-5bce-4561-8ed5-f82e09ad4b29",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0657ed12-b9ad-47d1-95be-44bf98619142",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7c3001f2-afbc-4d22-a9af-0365d0b4666c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a9d3b4d-83f4-467f-b509-38acfc5627a5",
"db_currency_id": "29e92639-99f9-4492-b49f-d8c32731f752",
"db_language_id": "e7675847-d991-4b17-9dba-34cc9b3383e6",
"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-11-04T17:28:07.0097878+00:00"
},
"modified_dateutc": "2026-11-04T17:28:07.0097878+00:00"
},
"marketing_segment_id": "11821a27-d572-46d7-ac2a-50de7bf15816",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a70fa6d9-e713-4cec-89e3-1adb7d514605",
"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": "8cfaeddb-bb90-40e3-a8e3-8fa0cc9ef4f8",
"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": "96079f02-bc82-48a6-8287-93aa19c42d91",
"db_country_code": "sample string 28",
"feelist_id": "5911ebe0-2a15-4640-935c-0c1b8fddf8e6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "61aaf123-f9dc-4a28-8212-0cc35b11b1f5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "45896fe6-40b1-473a-89f7-7c0237492f43",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-04T17:28:07.0097878+00:00",
"db_currency_id": "4c484830-ada9-4ebc-a325-b77a83e48694",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e8cb76d-8513-4557-b272-27a1029cb225",
"company_type_name": "sample string 32",
"company_type": {
"id": "7773e928-f72d-49a0-8c00-493ca3c48ba1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "376e2ca9-1d12-4d1d-aa03-4f68db1c025b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "320c6a54-3e25-4b26-aab1-03696f79c3e7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4cb8c923-063b-40e6-a28a-97fe2b830c89",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d54f7626-ec84-48db-ae23-0804984a18ed",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3e57faec-2c73-4321-8bd5-e29b9124b0e5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-04T17:28:07.0097878+00:00"
},
"company_sector_id": "5baef26a-6f09-4bd9-a210-a3a2a2765ac8",
"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": "0ef33c45-7990-44ce-ad43-e10bf3061701",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a22d479d-294c-4fb2-afab-2186795a4ee2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d28d9507-76f5-4494-ac6b-3eaf4fbc9ae6",
"account_manager_user_code": "sample string 56",
"company_status_id": "53d05f28-28c4-4b1f-b032-c48fac74c08a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-04T17:28:07.0097878+00:00",
"id2": 60
},
"db_language_id": "3ef6b022-61ba-4061-8e28-75318a0797b2",
"db_language_code": "sample string 7",
"db_title_id": "22b68006-144f-473a-b92e-4ffd5e10f61e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-04T17:28:07.0097878+00:00",
"create_date": "2026-11-04T17:28:07.0097878+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-11-04T17:28:07.0097878+00:00"
}