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": "9259f708-3fb7-498b-8653-d344d749db11",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ee8a6477-06e1-461e-9233-34e60326c057",
"company_code": "sample string 5",
"company": {
"id": "f8a72632-157f-4644-9912-bc848ac24bc5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-26T11:50:47.8915261+00:00",
"sales_territory_id": "fbd0bf04-21b4-4997-9982-970f487b3625",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "454c71f4-e2c6-4865-864b-0c10a7ab76b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1984d665-ecc1-41f3-95b4-1558b922b6ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9676b26b-4dc4-4e9c-aefb-cdda389c87e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "205adaa6-330a-40a6-ad80-4944bbd1456f",
"db_currency_id": "80ea3366-863c-4fd1-b1f5-5b3d0254ef27",
"db_language_id": "f5ba8fe8-af81-4919-aaf7-275a016a7e04",
"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-09-26T11:50:47.8915261+00:00"
},
"modified_dateutc": "2026-09-26T11:50:47.8915261+00:00"
},
"marketing_segment_id": "3a529382-d85d-471a-9e93-68f8a1173af5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ea168e9f-dee5-4c7b-ab20-cb0eefd39cb6",
"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": "2a8a197c-000f-43e4-a4f6-30bc79ad3f72",
"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": "446a642c-8c78-4786-b59a-e18f0ed5fc7e",
"db_country_code": "sample string 28",
"feelist_id": "f4e04674-eeb8-48a6-b556-35cb9f5ed571",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c8afb17d-d622-47ce-855c-3955c993417c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "60fd928d-706b-441e-a8a3-257dad23ac2c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-26T11:50:47.8915261+00:00",
"db_currency_id": "28d3e418-f4eb-4649-b913-576190a58416",
"db_currency_code": "sample string 10"
},
"company_type_id": "c587bb99-e151-450a-a7d7-01055b75aa46",
"company_type_name": "sample string 32",
"company_type": {
"id": "7e863743-5bd6-4e06-94fa-4aaf57145fb6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f11195f8-87ad-4cbe-bfaf-ac2a0dc6e6b8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af4c4813-4ca4-4ec2-8af7-3124eff72ce4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3c522b23-7831-4381-b5c8-5a51a525e7dd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4beffa9c-afc5-4d4d-b038-cde4368ae62a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "88a47eab-0cb1-4537-8b5a-7c7cad3bfc99",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-26T11:50:47.8915261+00:00"
},
"company_sector_id": "0139a49c-3ac4-4cfb-9f9f-d9e8b7b595ea",
"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": "9bffcdf9-430e-429a-8dc5-3d12160e4c63",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "98081022-c788-4713-8f29-1c46ecadd75c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e4ee6046-aa7c-4c7a-b78a-7714a91db178",
"account_manager_user_code": "sample string 56",
"company_status_id": "3a7f6fe9-1c58-4d3c-8b2d-2e6fb51ca987",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-26T11:50:47.8915261+00:00",
"id2": 60
},
"db_language_id": "53cd3001-b425-4a11-bd0b-d5eb416164dd",
"db_language_code": "sample string 7",
"db_title_id": "86aec5ea-8ad9-4f9e-aec6-0dbdbf6b2aa7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-26T11:50:47.8915261+00:00",
"create_date": "2026-09-26T11:50:47.8915261+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-09-26T11:50:47.8915261+00:00"
}