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": "24036e53-602c-41a5-8fa6-bc328d80acaf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "95aa81f9-7efa-404c-8aa1-62aa9bcc7f2e",
"company_code": "sample string 5",
"company": {
"id": "f9b645aa-e927-4f7a-b4e6-81352c6fdb69",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-23T19:11:40.2738851+00:00",
"sales_territory_id": "1dbe3866-db2f-4b1e-8688-558fbd086725",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "09a3c406-633d-4e08-8567-0bb0f2499657",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b34b61ae-b857-4744-acda-b0d562c299c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26fa5d61-79e2-4e4f-9c43-c66a982c9159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "041c1926-a3c5-4e7a-ad22-8f6652778dc9",
"db_currency_id": "71758fcb-2ac6-4f2d-b06a-54b602dad6d0",
"db_language_id": "2c370cf2-a2f9-4e8f-9a99-5df146834f4e",
"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-23T19:11:40.2738851+00:00"
},
"modified_dateutc": "2026-07-23T19:11:40.2738851+00:00"
},
"marketing_segment_id": "2af7f5ea-6fc1-478d-8b25-f14d101d988e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a2b22f2c-4a9a-4ca9-9ffe-15b4d2230e14",
"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": "bcbb47f8-b4a8-43c7-b494-e2bcea47137d",
"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": "d13ef93b-f216-4b3a-aecb-42ec6e964465",
"db_country_code": "sample string 28",
"feelist_id": "a7b20d98-66a3-473a-a863-a0f515ef9219",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dd8f995e-3ded-4028-98a1-c3bf1d188f39",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8b950888-d9d5-4aba-b8a2-30f489b59d19",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-23T19:11:40.2738851+00:00",
"db_currency_id": "e352d517-214b-4db6-b015-1632df0e307c",
"db_currency_code": "sample string 10"
},
"company_type_id": "fa928986-73ac-4563-b5df-2c995d2dda72",
"company_type_name": "sample string 32",
"company_type": {
"id": "d247a6af-3ec7-4f7f-bd2a-d9571a013500",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c624953-d787-4baa-8618-a1d4542fdfd9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "45967690-86c4-4b9c-83b4-007532af5c73",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5183e9c8-fe7a-427a-b352-3df68b9dd61f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "96aa318a-4b97-4c82-8872-34ebb57dd1b3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b6692789-585c-4d64-b0ff-dddb92505e66",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-23T19:11:40.2738851+00:00"
},
"company_sector_id": "2f0ff5e2-1607-4df6-aa19-f9524b7353c7",
"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": "5a6c4ee2-28ea-4959-8cfa-729f11d2458d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "187639cc-be27-42c7-8ab8-fa1af67bda11",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0b2731f2-bf96-426e-bd4d-c898487c9598",
"account_manager_user_code": "sample string 56",
"company_status_id": "c673a25c-341e-47c3-b056-b85653f0156a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-23T19:11:40.2738851+00:00",
"id2": 60
},
"db_language_id": "807a19aa-a1f7-4194-8e93-cbd94fb1a2f8",
"db_language_code": "sample string 7",
"db_title_id": "a0839769-e7f5-4f76-baca-c5abfac65e7f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-23T19:11:40.2738851+00:00",
"create_date": "2026-07-23T19:11:40.2738851+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-23T19:11:40.2738851+00:00"
}