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": "0c17a94c-3557-4864-8c36-4bc222390945",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3367f9d7-1d11-43d6-8569-c466c6023194",
"company_code": "sample string 5",
"company": {
"id": "dfb96557-b53a-40b5-8067-aa7eed19efb6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-05T13:37:43.1868367+00:00",
"sales_territory_id": "b3fac058-0022-4aa8-bbf6-c9d8d5235296",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fa7ba28d-c612-4dc3-8c6d-fa2294edddfe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6ae903dc-3ad6-4ca4-b4e4-824c9af31c0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "108c1355-6b75-4540-b0d8-0a64c7d65900",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0590797-dc9c-4aa1-bcd3-e497466c6931",
"db_currency_id": "c1b91563-9cd4-4b7f-b39f-c5b03fa2dee8",
"db_language_id": "4c665a50-f395-4dab-a0ea-953b6584dcfc",
"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-05T13:37:43.1868367+00:00"
},
"modified_dateutc": "2026-01-05T13:37:43.1868367+00:00"
},
"marketing_segment_id": "32576008-68ef-4734-afc1-81b6f4f233a9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bceb7f0f-47e5-412a-8139-c29373cf57fb",
"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": "dbcf5bf7-250c-4140-9f7d-b882d78eff7f",
"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": "cf8bfcc3-5663-4931-8d5f-947bfa8c7ada",
"db_country_code": "sample string 28",
"feelist_id": "e255fda0-5c2a-4ac9-8417-6d7c75b2354d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "de3f6aa8-dc71-49b5-bef5-85ff36ee38f4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f919706d-4474-4677-ab36-c046dd8bee72",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-05T13:37:43.1868367+00:00",
"db_currency_id": "ac1f302a-1149-4951-a333-4ac140b85fea",
"db_currency_code": "sample string 10"
},
"company_type_id": "4536a144-6c92-4731-9cd5-c52664f5dfee",
"company_type_name": "sample string 32",
"company_type": {
"id": "ed7708a6-da2c-4213-b4dc-cf43ef38656c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ee0a0d2-b6f2-4d09-9c58-7eed516d25f3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f5e32558-8749-4d7a-b3bb-f1efa19a6e6d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a5ab62e2-ca4e-466d-a828-b7b1a5ed4d89",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d8e917f2-98a9-46be-b7a9-a5fd7043f4d2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3167036b-96fa-48b8-8e19-28ec47e6fbee",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-05T13:37:43.1868367+00:00"
},
"company_sector_id": "382edce6-293a-4d18-b83a-a1db9967a9ca",
"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": "df46f83b-fdf5-4e26-81fe-e3afe47b72fe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a3e85d36-3574-4c4f-8752-5f29b68e69bc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "50ad2ce9-e041-4c21-927d-a8c54ac2ff9a",
"account_manager_user_code": "sample string 56",
"company_status_id": "f16cf054-7eb0-43ea-8ab3-0ee1cd03c8b6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-05T13:37:43.1868367+00:00",
"id2": 60
},
"db_language_id": "28239824-cc2b-46e9-b6dd-515892dec5c7",
"db_language_code": "sample string 7",
"db_title_id": "5120d24e-5033-47a7-895a-4564b8a141ce",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-05T13:37:43.1868367+00:00",
"create_date": "2026-01-05T13:37:43.1868367+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-05T13:37:43.1868367+00:00"
}