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": "e1af6ef3-af9a-4dee-b4e6-26b8da24348f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c658bf0f-69a4-432d-b021-d1f419a439b8",
"company_code": "sample string 5",
"company": {
"id": "af2b757a-5c13-4568-b05f-3323fc3c63da",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-22T15:14:41.5858427+00:00",
"sales_territory_id": "524f32aa-8793-4410-a772-29da283c60c5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4e1ae967-34fd-47e6-bc4f-77d24376e098",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "acc4fe12-61aa-4352-a834-0c3ba7c532fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc3498a1-dfbe-41b3-bb6f-7ea2eb0c4e14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78850580-4902-4ebc-a81c-3729e75454ef",
"db_currency_id": "1d6b1bf3-d195-4d98-825c-b8088f7b25e7",
"db_language_id": "66708757-ac70-46b5-9f30-bc4ee7773f50",
"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-22T15:14:41.5858427+00:00"
},
"modified_dateutc": "2026-07-22T15:14:41.5858427+00:00"
},
"marketing_segment_id": "a66767c8-8c3b-4fa7-9044-7a4e588488c9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2971bfd8-72ad-41d4-a30d-43b6829fdf06",
"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": "365eac94-01b9-41b0-bc44-75c78f5e84ba",
"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": "a4b4a108-ff32-4a02-8c46-ab6666c47c81",
"db_country_code": "sample string 28",
"feelist_id": "b9bcb8e3-7615-4076-afe8-4961fda4903e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4c1e728f-95a8-425f-8a5f-f160e609616b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1dd639b1-63c5-4632-9a06-708a4f0e571c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-22T15:14:41.5858427+00:00",
"db_currency_id": "9c8beaf2-f98f-42ee-8eae-850a2d2dde51",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e7c781c-65a8-498e-9706-3c4aaab12ab0",
"company_type_name": "sample string 32",
"company_type": {
"id": "9f518eb7-efd8-48ee-9d9b-8d37b501880f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9078e804-3725-4d59-ae65-670e7b8dd6e2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "00740d74-cf71-466d-97a2-a71fb18dfabe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bb47c2f4-4209-4305-9eb1-b4a2afe86e40",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9405e102-0942-46a1-aaad-97095fac271c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fe2ee130-7460-4c29-a1d0-dd9d219fbfd6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-22T15:14:41.5858427+00:00"
},
"company_sector_id": "08e81522-4c0f-46ee-ab76-a85d20f94886",
"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": "11a9285e-0e6c-4f7d-810c-84f3464377a5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c48cde8a-32b7-4d17-8069-b88283bab151",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2d0db463-1eb8-4859-932f-690c793179e5",
"account_manager_user_code": "sample string 56",
"company_status_id": "8020b218-a945-46d6-9c44-4db6104bb58e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-22T15:14:41.5858427+00:00",
"id2": 60
},
"db_language_id": "61e3ead8-a5cb-46b4-9d40-e61b111152c5",
"db_language_code": "sample string 7",
"db_title_id": "6373a85b-a190-428e-aef2-b187592475ad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-22T15:14:41.5858427+00:00",
"create_date": "2026-07-22T15:14:41.5858427+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-22T15:14:41.5858427+00:00"
}