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": "bab6cfda-7ebc-4378-81fe-f95d7f82a3f5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "826d4773-3708-4874-a724-8a34e3035aa3",
"company_code": "sample string 5",
"company": {
"id": "f9df5cb4-c18d-402f-8205-a6771979b4c2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-03T12:45:34.5251012+00:00",
"sales_territory_id": "be670cf6-912b-4435-b3d9-333ca94a691a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1ab90f96-0e4a-4881-94fc-848c9071754a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4afb13ae-48b6-4606-860a-afa3d995470e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb0d4655-14b2-43aa-a0c8-05a9bf760918",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1df46165-4e09-4410-a4d9-7da5a3416997",
"db_currency_id": "318389b0-8b99-4ddc-8bed-2945f4590055",
"db_language_id": "f2b9f7cc-2edd-4052-ae58-66655436f7a1",
"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-11-03T12:45:34.5251012+00:00"
},
"modified_dateutc": "2026-11-03T12:45:34.5251012+00:00"
},
"marketing_segment_id": "62c2929e-8438-4994-8030-fa00aea0e689",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "56e9ca3b-8aa6-47f4-aa88-1bfe7d713458",
"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": "1ca05c31-ba32-49b1-a793-0a66649d348f",
"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": "441986a9-a270-46dc-8b37-4cbd37a4af1c",
"db_country_code": "sample string 28",
"feelist_id": "0f9b4aa5-5c61-4b2c-9dc1-d48758401aed",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6a42678b-c4f1-4a7b-a502-335aa737eed6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2900fbbd-daa1-42a8-95a6-6029c7342d34",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-03T12:45:34.5445181+00:00",
"db_currency_id": "c85c108c-73b7-4736-ae0c-fcd17d5c7e81",
"db_currency_code": "sample string 10"
},
"company_type_id": "47b3f458-e32e-4402-b064-649615cfe013",
"company_type_name": "sample string 32",
"company_type": {
"id": "67688c20-7146-4dc0-91cc-721d660ab776",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff236459-0463-4907-990d-f97226f0fb2c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d9972678-c459-4f66-b536-6bbfd9ade40b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7c395a68-7333-4287-becc-3376b5990594",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "706a68ee-cdd4-4626-b823-71f6f75bfce6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d58aac7d-8cda-4c9b-9ad2-264620d53e40",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-03T12:45:34.5445181+00:00"
},
"company_sector_id": "ccd0d49d-d6a5-42c5-8b01-838a2a3325a9",
"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": "cac9d835-2f50-4e36-ac81-67b283126a41",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "419cb2ab-dc7c-4c7f-9ec8-f5f7be0cb991",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7bb6abf3-1bec-4072-be05-5daf2b09468f",
"account_manager_user_code": "sample string 56",
"company_status_id": "32a2661f-b754-4f58-a63f-9aed5879b63d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-03T12:45:34.5445181+00:00",
"id2": 60
},
"db_language_id": "6ba3ef79-31b9-4b85-be93-950401566d18",
"db_language_code": "sample string 7",
"db_title_id": "ea09f603-efc2-4806-9f71-af802b332564",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-03T12:45:34.5445181+00:00",
"create_date": "2026-11-03T12:45:34.5445181+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-11-03T12:45:34.5445181+00:00"
}