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": "18690721-9121-484b-a45c-e84db3470a8b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "544ac1e1-a72d-4c57-a3c4-16919a2aba5c",
"company_code": "sample string 5",
"company": {
"id": "2e34c7b0-007e-41a4-976b-fbdaeea1912f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-28T05:46:52.2479119+00:00",
"sales_territory_id": "1ff2939d-0aac-4d97-81da-e1a933d74c25",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "41757017-1f6b-46ca-b5af-ff8bd65452ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4bfbdca4-e079-41a7-be25-aa6d79b54e4d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c62aae6b-339c-4537-8fab-510806597eb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "20338d23-7259-4e38-9675-4943f2bbd537",
"db_currency_id": "c22c19a3-cfc9-4cf1-b7e3-22e65419ca83",
"db_language_id": "3600a2f3-f81c-407a-9c0f-66be90b183b1",
"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-08-28T05:46:52.2479119+00:00"
},
"modified_dateutc": "2026-08-28T05:46:52.2479119+00:00"
},
"marketing_segment_id": "a9ae2483-3606-4bf8-8ab3-872ed87bb82a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ad6e21a4-f92c-4afc-a95c-bacc23ff1660",
"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": "8998343c-7ad4-486a-b83d-cc8eb4484f0e",
"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": "8b8a6be6-27a4-48a7-b09f-f314aea46319",
"db_country_code": "sample string 28",
"feelist_id": "4af58b34-d5fb-4424-9b38-36415a33aa71",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7d761151-a34f-488f-bfb5-8f0085dfc7a2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "681c443b-c45c-41a1-87d8-272b6ad8264c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-28T05:46:52.2479119+00:00",
"db_currency_id": "a8bf6424-39a3-4f03-81ae-648ed4963864",
"db_currency_code": "sample string 10"
},
"company_type_id": "c818cfcd-8486-47d6-9343-1a1533227809",
"company_type_name": "sample string 32",
"company_type": {
"id": "759a134d-69af-4df8-8209-4d1b05661476",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "688733b7-5cc5-4a7e-a131-24f79876dcf1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6655d310-d169-4ae7-994a-a176a240f45d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "af87c573-0c5b-40da-aa6d-ccb3f2913332",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "65a7de5a-8c1a-4a3e-b50c-5838cad40c4b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "400b72be-6e40-48de-8236-9151fbf8c218",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-28T05:46:52.2479119+00:00"
},
"company_sector_id": "779990c6-fbda-4fc5-bc10-117213e201d9",
"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": "484b36cf-de89-4e20-b513-4ae0366682be",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d48fc00d-1730-45ee-997a-2b0c03d04164",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4d88803-d3d4-4786-b87c-387d1052f956",
"account_manager_user_code": "sample string 56",
"company_status_id": "d181f12c-697d-4ce3-8972-7a291a060be4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-28T05:46:52.2479119+00:00",
"id2": 60
},
"db_language_id": "606bdd38-61f1-4cb6-be3c-41eb7b338c91",
"db_language_code": "sample string 7",
"db_title_id": "ad3ce3b6-6b9f-472a-817f-16ed79f7f981",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-28T05:46:52.2479119+00:00",
"create_date": "2026-08-28T05:46:52.2479119+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-08-28T05:46:52.2479119+00:00"
}