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": "3f9841e1-0966-4c93-9a33-42e80beca402",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a6867197-9bb2-422e-9dcf-5a6d20903a21",
"company_code": "sample string 5",
"company": {
"id": "19501b89-87eb-4086-a4a4-4b9f80f21cd7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-25T19:15:39.7350863+00:00",
"sales_territory_id": "2c3b1ffe-55da-43c0-ac52-a0a1e2969e5b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a91a3d77-2b2d-4bdd-ada7-7af5bf7ed7ff",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "619ed690-224e-44b4-807e-097b9cea4882",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "238527db-5fdc-47fe-bb77-2b04a9f7397b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e032ee62-c93f-45af-a1ad-8346528de76b",
"db_currency_id": "a9839836-6fbf-4bad-a65e-58a4091ad4f3",
"db_language_id": "9dbdf9c5-e833-446f-8f05-56aadf8dc8e1",
"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-07-25T19:15:39.7350863+00:00"
},
"modified_dateutc": "2026-07-25T19:15:39.7350863+00:00"
},
"marketing_segment_id": "d378feeb-0a2a-4ed9-bafe-0bb22c114151",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "72ad4c41-9bba-4899-9ef9-d875f972b27b",
"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": "cb017f4d-adde-4436-b683-28b4e49aa220",
"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": "d6bf774a-e853-480a-a5ee-7cce1ad68adb",
"db_country_code": "sample string 28",
"feelist_id": "62d34348-c459-4936-988c-2cdb1f44dc54",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3e98a2d7-340d-4d39-8338-ce20fbf7b9ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b11cd960-6271-4ee5-aa86-01c873d0f4cd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-25T19:15:39.7350863+00:00",
"db_currency_id": "0d1eac9f-2ecd-4a1f-99f1-b62b3f7f85f4",
"db_currency_code": "sample string 10"
},
"company_type_id": "50ccf0be-6c35-4976-92b6-fa60585b699f",
"company_type_name": "sample string 32",
"company_type": {
"id": "2786749c-4edb-4e9f-8c9a-0177e526ec57",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30b03e42-06c6-4fcc-a833-f7511432b328",
"sales_organization_code": "sample string 5"
},
"db_language_id": "64fdac51-dbf2-409d-accb-90cff84468ff",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "082d78d9-bc97-458b-8060-61d8e1eea883",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b9467452-8a43-4c52-8f98-2ff0cc4ebefa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "76451c2b-575d-42c5-b2ae-9c335b83acf1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-25T19:15:39.7350863+00:00"
},
"company_sector_id": "e4041e5c-18f0-49db-bb97-c1d188836cdc",
"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": "304c365c-0a8f-45ea-9be5-5f3de44e443f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cfd669a0-dac8-4819-839e-b5e3a6c2718c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8f8218d1-3f2b-4549-b039-875eb162bc89",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ea1ab67-097c-449c-85f5-5244ec06bd28",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-25T19:15:39.7350863+00:00",
"id2": 60
},
"db_language_id": "e22bd14f-15e9-4233-82c0-a380c6a1370a",
"db_language_code": "sample string 7",
"db_title_id": "aa5cb007-70c9-4fe4-b78e-f46b23746684",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-25T19:15:39.7350863+00:00",
"create_date": "2026-07-25T19:15:39.7350863+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-07-25T19:15:39.7350863+00:00"
}