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
{
"id": "43630d0b-0633-4a96-957a-9ce9610f3285",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a69d34da-a4d0-49c5-9732-207bef01f9c6",
"company_code": "sample string 5",
"company": {
"id": "0c152479-c272-4ae4-b768-26aa1fae6180",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-18T15:07:11.9662659+00:00",
"sales_territory_id": "8ce606f4-9fa1-427e-8ec9-0d88ca6ed75e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6ca229cd-2445-47df-89f6-05899a98cdf4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a6051fc2-33e5-4c7b-83c0-fa58d4763382",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "45f1d5ac-2b36-4590-9e1d-839846c5d0b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0357d05-93a1-49a7-9532-73c616626708",
"db_currency_id": "1103ddb0-3ae4-47bd-aa03-02aea0929b23",
"db_language_id": "a08e3a75-af1b-45a6-934e-27ca074fd24f",
"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-18T15:07:11.9662659+00:00"
},
"modified_dateutc": "2026-11-18T15:07:11.9662659+00:00"
},
"marketing_segment_id": "b569d825-64fa-4dfc-a1a8-970d0c435285",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6f3a33a2-f472-4eb5-8b6e-f25ab618b64c",
"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": "c037aec3-a808-4c38-8fd1-eb0eba565914",
"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": "c06f5c19-20df-4c1e-b9fc-37430d978d17",
"db_country_code": "sample string 28",
"feelist_id": "ec5d5dd7-66b7-4643-9471-2fbbb1b68663",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1f9650ef-af34-4b5b-827f-f937113da64e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5c8666b7-7b3c-4771-8b75-7bddcc11a4c8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-18T15:07:11.9844823+00:00",
"db_currency_id": "6e9fbfa9-1616-4769-a264-1cb6d6db31f9",
"db_currency_code": "sample string 10"
},
"company_type_id": "4b4810f7-9457-46e9-8454-18d96d882b63",
"company_type_name": "sample string 32",
"company_type": {
"id": "b49fa758-e4b3-4b1e-a13e-870bab16486e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "10842f23-4407-4d6b-beff-216b62bb215a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3319dbeb-2697-47f3-b155-6ab8324cf9bd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "94ed84dc-801f-4896-9692-e50b0237c9bf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ab689f6b-fa01-4f10-9f77-dfb0b7864ea2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a5a98512-815f-4e18-8664-24df75751088",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-18T15:07:11.9844823+00:00"
},
"company_sector_id": "dac52119-d744-4d1b-a272-37518cf33e3b",
"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": "ad5ea1c5-f7f2-4445-ba9a-bc14e19c67ac",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "90730c7e-4691-4c0c-a8ff-563353c442d9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d49f470c-4ee9-47cf-bf65-7fe956f625bd",
"account_manager_user_code": "sample string 56",
"company_status_id": "9d6fd4cb-ec3c-4502-98e4-6dbbc39e2124",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-18T15:07:11.9844823+00:00",
"id2": 60
},
"db_language_id": "0cbf2605-5448-4277-b5c0-b64df068f35b",
"db_language_code": "sample string 7",
"db_title_id": "223c7a20-d966-4596-8236-123a80ac0c59",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-18T15:07:11.9844823+00:00",
"create_date": "2026-11-18T15:07:11.9844823+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-18T15:07:11.9844823+00:00"
}