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": "937e4664-9ed8-4fc2-9862-3d59b1ce71b4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "159b24f3-1a81-4eaa-adf6-460733812267",
"company_code": "sample string 5",
"company": {
"id": "f04e698f-85e0-4721-baa2-7c66584ee445",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T08:32:53.4294962+00:00",
"sales_territory_id": "56bcc901-d072-436a-8950-a0b2dd3a9148",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a1ccb839-156a-409c-8b3c-9ec2a1b741c0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0cede40e-7e49-47b8-8dda-87f1fc752da3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "36b75cc5-e66f-4a49-8388-1e8cb4564cb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "459cf722-9b4e-474f-9e9c-bc514ad159cd",
"db_currency_id": "fe9eabf5-3d6d-4b6f-baec-7aceaa723c93",
"db_language_id": "30ec0fab-02f6-4a54-a2d6-4105b194940f",
"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-06-26T08:32:53.4294962+00:00"
},
"modified_dateutc": "2026-06-26T08:32:53.4294962+00:00"
},
"marketing_segment_id": "81221882-0991-462e-9313-0db0d2d5e51a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6b679771-06ed-46aa-95f7-e913a2610b98",
"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": "e841ddf4-4429-4b15-ba61-742021adf554",
"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": "ff8d62c6-c77b-4da3-b360-b04cb835d4ab",
"db_country_code": "sample string 28",
"feelist_id": "c1dbbf09-d834-4540-96aa-e420ea36ce43",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "135aa763-0d8d-4bb8-ab39-72bb9f420043",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "49e40e97-f935-4b8c-8d0f-ccadd952bdd0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T08:32:53.4294962+00:00",
"db_currency_id": "e1e458f3-6105-4acb-963e-ecfe3d846a95",
"db_currency_code": "sample string 10"
},
"company_type_id": "867c5984-8320-4a02-b57a-c51d679b1bfa",
"company_type_name": "sample string 32",
"company_type": {
"id": "8d1310ed-2467-4cc8-9d0b-6f939edf3ceb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a4325c7-4a0f-47f4-9c2c-29919798113b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9bf0d44f-a513-4675-97c0-1fa4d088ad07",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ded53e10-3aa9-42c5-91e7-ff6e9946f534",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3a704c60-d217-45b1-991d-1559770f8b46",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "02721901-8c7e-4c05-aed6-7b710fda9b6b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T08:32:53.4294962+00:00"
},
"company_sector_id": "69662822-2dc5-42e8-9dcb-324b2d51f9bf",
"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": "9084e47c-0eae-42bd-9560-058eba76494e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "42bfbd63-bc10-47a3-b038-e8994f8da263",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f87cca56-22eb-4962-9c6f-8e5f6a56328b",
"account_manager_user_code": "sample string 56",
"company_status_id": "1237f515-a15e-4763-8523-c550a5223f10",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T08:32:53.4294962+00:00",
"id2": 60
},
"db_language_id": "03a7c1a2-e4a5-40ef-87e0-5c50816038c3",
"db_language_code": "sample string 7",
"db_title_id": "d335a6c0-dfbd-45ac-afd9-c0a739a7a0d6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T08:32:53.4294962+00:00",
"create_date": "2026-06-26T08:32:53.4294962+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-06-26T08:32:53.4294962+00:00"
}