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": "496946dc-c014-4a42-a2e7-bd4ac948452d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "df39f009-2641-455b-82e8-664aa2246432",
"company_code": "sample string 5",
"company": {
"id": "738f07ab-3340-4a03-a500-adca7d577bed",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-27T06:06:21.6015119+00:00",
"sales_territory_id": "0121cfd5-42a4-4ff4-abc9-d8797a15d771",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "21c5c48a-1a12-4dc6-871a-298f34febaec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ac7bdac-6629-4915-8064-93ab3f5e01be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3fa32967-7737-4e10-8049-adc9a6f559ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0da0970-fe90-4abb-82f0-8b7bbb30a551",
"db_currency_id": "a2eb3782-6188-4fe2-bbc6-8164a2b070e2",
"db_language_id": "e05fc6cb-3fc4-4a63-bfd3-6bbf783f8e3b",
"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-27T06:06:21.6015119+00:00"
},
"modified_dateutc": "2026-02-27T06:06:21.6015119+00:00"
},
"marketing_segment_id": "886d9604-a6a3-4f72-98d8-f7db1dbcf055",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d2fa33d7-33a2-4548-a4df-3f8984396b15",
"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": "2425db43-0383-4a70-a758-30d84483e9ed",
"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": "0e59667f-9e1d-4d6b-88d6-a50ff1dc6156",
"db_country_code": "sample string 28",
"feelist_id": "08097961-5531-48e2-b2f8-189d5121bb0e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "81658bff-84c5-4da6-b74c-66c6c1e01852",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "36c4a493-38ae-4e58-9679-dddeff5a1c24",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-27T06:06:21.6015119+00:00",
"db_currency_id": "24de06ab-7d83-4f04-b5d4-d9780633605b",
"db_currency_code": "sample string 10"
},
"company_type_id": "3fea6d7f-ecf3-4a08-9742-7e55c20d7ed2",
"company_type_name": "sample string 32",
"company_type": {
"id": "b2e2cb4b-4555-435f-ac08-810632acba69",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3e018bfd-0d48-4809-b3d9-ed2681972ea1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "58d5239c-0253-4405-9a03-a75202a33070",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b515e2fd-7be7-4db2-8192-6f46590a5e62",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "29411545-fd97-4c08-8b90-679a0ca19138",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "945217c1-a07f-4f3b-8574-79b68e5edad1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-27T06:06:21.6015119+00:00"
},
"company_sector_id": "08be2cd4-9422-475c-acb0-45f40f6d81fc",
"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": "63a56f59-0f0a-482e-9e55-6805555d0260",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b5ff4c87-3540-4b92-9582-d8f7ee101c23",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8e0e49f7-530d-4017-abff-67bce42a92f4",
"account_manager_user_code": "sample string 56",
"company_status_id": "7f5e79ed-cd0e-478c-9de4-ab26ccada6fd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-27T06:06:21.6015119+00:00",
"id2": 60
},
"db_language_id": "22c1e420-249e-4953-b9e7-e8cc502f1c84",
"db_language_code": "sample string 7",
"db_title_id": "db00cfa2-7797-44f5-ade5-b04017154f1b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-27T06:06:21.6015119+00:00",
"create_date": "2026-02-27T06:06:21.6015119+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-27T06:06:21.6015119+00:00"
}