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": "a35c2a69-d27f-45c9-8b68-0ab94a40ff49",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a58bf322-e438-48b9-af63-d9072284cb8f",
"company_code": "sample string 5",
"company": {
"id": "53fdd4c4-0ae3-4e2a-b50f-90cc72b9345a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-18T22:05:50.7828067+00:00",
"sales_territory_id": "fbaafbb4-2de1-4fbe-b4d9-a4514275f916",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "169adba2-be14-4b6c-bda2-3da71efba397",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e1e74489-c8e1-43f9-a219-dea090fac2ce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb5a59cd-e32c-4cb6-894a-1f4d7317228e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73de6026-5081-40e1-b95e-c321cf4b9e19",
"db_currency_id": "d72c2d76-0447-42c7-b8ce-0ceee1816759",
"db_language_id": "a5f573b3-c738-429e-af0d-9ea5008eb05e",
"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-18T22:05:50.7828067+00:00"
},
"modified_dateutc": "2026-08-18T22:05:50.7828067+00:00"
},
"marketing_segment_id": "da3a279d-e278-49f6-8770-6038cfaa6fd6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4dc2b516-442e-4c7c-93ac-7d883bc20624",
"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": "54aa6b67-a625-4496-a779-47de6429d9a3",
"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": "9001ccc1-8af0-47e1-85c6-1df5c68a1602",
"db_country_code": "sample string 28",
"feelist_id": "ccc8c204-4012-4bf1-bede-e703bdc3f800",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "18640f8a-3bbd-4708-84c4-18903e4bfd08",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1b005845-7c43-4cdf-ba84-e27366de6042",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-18T22:05:50.7828067+00:00",
"db_currency_id": "d69010ea-672a-4f9d-86d2-a6456742c47d",
"db_currency_code": "sample string 10"
},
"company_type_id": "14cfaebc-0a97-4c62-b5a0-e5d7cb3ac53a",
"company_type_name": "sample string 32",
"company_type": {
"id": "05024c4a-1375-4ccb-a69f-ea6516b9b2fa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e8a0b263-926b-43ad-8f02-016164e7cf84",
"sales_organization_code": "sample string 5"
},
"db_language_id": "053c6cae-170a-434f-b92e-f1bae6f31754",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3a1c1f7f-613b-4eb0-ab45-e51376c0761e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f7a40224-9cb5-46bc-87cc-edcf886b6c9e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e6b31738-9d51-4793-bec1-04dffcf81740",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-18T22:05:50.7828067+00:00"
},
"company_sector_id": "fd6aecc0-bed8-4338-ad18-a33826df80fb",
"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": "9c502c01-38e8-438e-84a2-d3469f83fa4c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bc23970e-178c-4547-8f45-587b6cc5466d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3f38059b-058d-466d-a67f-e417dc8128b5",
"account_manager_user_code": "sample string 56",
"company_status_id": "2a5a30f5-c64e-4438-bc8c-9e5793f3e308",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-18T22:05:50.7828067+00:00",
"id2": 60
},
"db_language_id": "e40a46b0-2b18-4d8a-b5b5-b6f317c57e0d",
"db_language_code": "sample string 7",
"db_title_id": "2a6dc2c2-f335-4083-9523-82c9f9431b2b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-18T22:05:50.7828067+00:00",
"create_date": "2026-08-18T22:05:50.7828067+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-18T22:05:50.7984278+00:00"
}