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": "9d59fd4f-ecae-4168-8126-a05616aa6ce5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dadbde99-3474-42d5-903e-435898a1ccc0",
"company_code": "sample string 5",
"company": {
"id": "17bd7374-3712-4b28-843a-9e64b07dba1d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-21T19:20:19.64929+00:00",
"sales_territory_id": "dcd61525-e7ce-4ae9-8a4a-184ff2fb5005",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9ae44a61-9e3e-4969-826b-76e5506c1a08",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74f7c1b6-07b3-4138-818b-f7120758f985",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7527b468-94fc-4935-85ab-80725c20056c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "115b8589-cea8-4db6-af38-fdebf2790611",
"db_currency_id": "7ae8b7d4-2d11-4e46-ba60-56720f93bf38",
"db_language_id": "772d7fc7-0526-4ecc-aec9-3ab55303782c",
"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-10-21T19:20:19.64929+00:00"
},
"modified_dateutc": "2026-10-21T19:20:19.64929+00:00"
},
"marketing_segment_id": "9d8ac105-e8d3-450a-820f-ad513ed35ed3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8067aaae-34d7-48c7-b95d-8e10307885eb",
"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": "48041b1e-03fb-419d-b971-ea3b2852a2a8",
"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": "c28fd372-fd27-4c92-b371-872c1d0ab950",
"db_country_code": "sample string 28",
"feelist_id": "31037fac-2697-429d-9786-a476a733e7c5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "755a7031-04c4-4a99-b318-8aba8bf3a401",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f14cc398-e5cf-4662-9934-edec89bd1d56",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-21T19:20:19.64929+00:00",
"db_currency_id": "42dc8369-bea4-49e0-9d9d-fb962ec99b6e",
"db_currency_code": "sample string 10"
},
"company_type_id": "a9313604-ba67-452e-b51f-a2492abeadc3",
"company_type_name": "sample string 32",
"company_type": {
"id": "de5b7182-99b6-4f66-99ea-154370dc3615",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "443c5211-40ea-4af3-9727-76d22931f778",
"sales_organization_code": "sample string 5"
},
"db_language_id": "be2f4113-d221-448e-823a-21f35206db49",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "41b2838e-ea94-4f43-9a71-7eb432d5f0e9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a0dcdf8d-72db-4772-9f02-0078e47f52fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "197c7809-aed4-4c39-999c-5b7c7559f85c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-21T19:20:19.64929+00:00"
},
"company_sector_id": "8b604b66-c968-4d1d-a628-3c1e561db254",
"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": "f882c012-ffef-4631-a764-5d26e5d7dbf2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c1b65968-1c31-45c4-a1ea-c9660d986af7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "073589d5-ea77-4277-9f0f-822f14e36a92",
"account_manager_user_code": "sample string 56",
"company_status_id": "6ba3d427-d547-4038-8584-7dac6e404a45",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-21T19:20:19.6598659+00:00",
"id2": 60
},
"db_language_id": "16de71fd-5023-4a7f-8eb0-b38759a8f898",
"db_language_code": "sample string 7",
"db_title_id": "e5d9a621-4580-4655-ad9e-b5707630d6ef",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-21T19:20:19.6598659+00:00",
"create_date": "2026-10-21T19:20:19.6598659+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-10-21T19:20:19.6598659+00:00"
}