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": "0f7e39e3-4492-42c9-82d3-edc63a27db14",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a852704c-6cc8-4ea4-90b6-bf7101e3cbd6",
"company_code": "sample string 5",
"company": {
"id": "d53defe0-7364-487d-8d52-ca0e7f0f4b3d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-23T20:46:57.207554+00:00",
"sales_territory_id": "a2085b02-378d-48ab-a96e-34605f545d5e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "62b40ec9-faae-41f4-b495-a7cda29a01ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4a6651e3-28b9-433d-824d-b06b5eb53b15",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ecf721b1-29f6-4653-9642-325b820393a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6da7c142-7682-473b-93f9-027d8180a3ce",
"db_currency_id": "8f213ac2-cc61-48cc-ac49-4ceaa1ef9683",
"db_language_id": "db70b9c4-8771-4cf2-ae44-8ee65821ec3a",
"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-23T20:46:57.207554+00:00"
},
"modified_dateutc": "2025-12-23T20:46:57.207554+00:00"
},
"marketing_segment_id": "cbdb814c-5f44-469f-bdea-a0d2f9b29c1b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8cc0c589-6951-4fee-ae6e-f58444b8af13",
"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": "95be6518-d93a-4e36-8581-2959e8fe396f",
"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": "096a8697-31bc-4965-92f2-1ad5c200e677",
"db_country_code": "sample string 28",
"feelist_id": "77c0a6e4-fdf7-4dec-8477-580a70ba28b5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6b819775-f01e-42a9-aef2-93c1700cb65d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "877d46df-b65c-4e02-b2e1-3984bb8b271e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-23T20:46:57.207554+00:00",
"db_currency_id": "cbe0a38e-7a9d-41d0-b544-ea4ce499a4e0",
"db_currency_code": "sample string 10"
},
"company_type_id": "f3219c4e-90f4-45e9-b7bc-85a0a6500d50",
"company_type_name": "sample string 32",
"company_type": {
"id": "da67180c-3c78-4270-98ee-8fe5f0e6a39d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88d17f0b-5be1-4c7a-81a3-fccd0cbfd197",
"sales_organization_code": "sample string 5"
},
"db_language_id": "15472b20-c7da-42b6-916e-4ed8d9b7731e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cd4735fb-84c4-4fca-bd92-9866438be143",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b3a1c855-24c4-4ada-bbbf-7b1f52fdeba4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b2c7ca16-22c3-45bb-98b0-faf0614966e7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-23T20:46:57.207554+00:00"
},
"company_sector_id": "0bfd20c8-1375-4744-8bfc-e2101d70281a",
"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": "872b7547-2354-4898-a4ad-d005531f2b1f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ccc18f5d-b2fd-4c97-a504-fed1e07084f3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d15f74a7-96d4-4be5-ba8d-7910605813cf",
"account_manager_user_code": "sample string 56",
"company_status_id": "21c3d627-41cd-423c-8496-f11ba8ab4909",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-23T20:46:57.207554+00:00",
"id2": 60
},
"db_language_id": "61fc3a46-9a88-4800-ab53-24e8cea51477",
"db_language_code": "sample string 7",
"db_title_id": "9619b039-437c-44f0-9214-0c02ad0e3452",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-23T20:46:57.207554+00:00",
"create_date": "2025-12-23T20:46:57.207554+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-23T20:46:57.207554+00:00"
}