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": "235bf8a2-6680-4852-853a-cf60bc00b841",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f5b33c7a-729f-47ea-a245-1a159eddf81b",
"company_code": "sample string 5",
"company": {
"id": "10f3111c-27d7-4988-9107-bd3a9b5e8be4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-31T13:30:51.8569276+00:00",
"sales_territory_id": "d717da28-f046-4d84-96f0-e066e789d607",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "34f08b11-c9dc-4a15-81a4-f928dc635b41",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bcd7663e-996f-4f34-bf6c-ee261d5b67a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08fca577-1c91-41dc-bf3d-dcf9e8730e62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22616bda-d126-466a-84d3-a748882da972",
"db_currency_id": "edd58c7c-0f77-4145-aa00-eb9e61235fe9",
"db_language_id": "121effe2-7e29-4029-9d0f-acdee3c92e50",
"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-01-31T13:30:51.8569276+00:00"
},
"modified_dateutc": "2026-01-31T13:30:51.8569276+00:00"
},
"marketing_segment_id": "fdde9b0d-2f77-466d-8f90-9e6818a24222",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bba89ec2-29c7-4f49-82a9-47aefe9ccd07",
"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": "9f4da0ca-7abc-4f76-b4af-59430b8e42ac",
"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": "21e217ab-382d-469f-820f-33f227d84027",
"db_country_code": "sample string 28",
"feelist_id": "da0a8b7e-89af-4f5d-84bd-ab51d3b60e88",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "13bfe2ab-2835-4462-932c-5aa07de006f1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "456b20e4-2f23-403c-a2af-a64c316f013b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-31T13:30:51.8569276+00:00",
"db_currency_id": "d0216f32-2ad5-4c90-a0d8-02d7e960977a",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5f351aa-aa32-4d67-a46c-862968275189",
"company_type_name": "sample string 32",
"company_type": {
"id": "a4275d3f-cf09-472b-8023-74d965f1b770",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b2211e34-418e-4732-b5fc-11f8bb7e8160",
"sales_organization_code": "sample string 5"
},
"db_language_id": "885536a3-6d24-47d4-ba75-513f69fd2691",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "74a711c2-24ac-4418-ab3a-55b46af6868f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cec435b1-fbcc-4acd-82d9-3f6de86b9eb9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0da2cf59-7c59-441c-8e16-1d3a77bfa8e5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-31T13:30:51.8569276+00:00"
},
"company_sector_id": "d47cd9d3-4c8b-4c50-b8a0-478588106891",
"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": "a66bf807-9adf-49de-8a04-d33ced7e73ce",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3b77ec7f-90a4-4c54-b5d3-0f98c9625515",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "be871fdc-91f8-4606-9cae-f55a3c4c42ae",
"account_manager_user_code": "sample string 56",
"company_status_id": "79ce83c2-f254-4f99-a2d2-8c93322bb939",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-31T13:30:51.8569276+00:00",
"id2": 60
},
"db_language_id": "532f6ce6-fa84-485a-bf6c-b156055c1b03",
"db_language_code": "sample string 7",
"db_title_id": "5d9970a2-5da2-4edf-a650-f5ae13c3c2fc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-31T13:30:51.8569276+00:00",
"create_date": "2026-01-31T13:30:51.8569276+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-01-31T13:30:51.8569276+00:00"
}