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": "fbc04423-f6fe-4e25-a65e-51fa6a99a53c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "88fdd83d-66b9-4f02-a553-b73f2feb5c43",
"company_code": "sample string 5",
"company": {
"id": "94c7f6be-2d74-4eb5-bf6d-d187d360d0db",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-05T17:27:57.0405551+00:00",
"sales_territory_id": "46cc82f2-9eb5-427e-bb78-74a7e65401ef",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "123bcb1d-c35f-4d60-af4b-952455b17985",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0d388af2-a758-4668-b180-55097ed9a90d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "613cf4ea-25c7-439c-bf03-80987e7f702e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99a19bf2-060b-479e-8072-47eed5c1f597",
"db_currency_id": "4ef012b1-c7d0-4bf0-831a-6e5a386382e2",
"db_language_id": "ba74b2b0-ca4d-41fb-8548-8e62676ea363",
"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-10-05T17:27:57.0405551+00:00"
},
"modified_dateutc": "2026-10-05T17:27:57.0405551+00:00"
},
"marketing_segment_id": "32c1fee5-886a-434c-8d1a-0a2253a4a767",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "82b73b35-bc6b-4eb2-b3d8-1d38ad85e096",
"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": "5ac3766c-10f4-460e-9578-c406ac264671",
"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": "39bb5a50-948e-4f61-a102-fd47cc4e6ac1",
"db_country_code": "sample string 28",
"feelist_id": "0d8426a9-4f67-4d46-b0d7-f40d9553ef15",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e32bef63-c216-406f-971a-fdcd27e04959",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1d932363-2d56-421b-9065-7bcc22ce7c67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-05T17:27:57.0541491+00:00",
"db_currency_id": "8de389ac-6a68-4316-82c4-d091557581cd",
"db_currency_code": "sample string 10"
},
"company_type_id": "0b08e29c-1475-4adb-be84-71f85a7471ce",
"company_type_name": "sample string 32",
"company_type": {
"id": "292326ba-f86a-4f56-b799-2cda746e0120",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "43b8cdf1-f524-4153-a412-3b29703a2364",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3b3d4922-86a6-4fe9-97fd-3dd859f5567d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5aa9b01c-e9ae-4c04-ba9f-663e2738d0d9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9ce463dd-aa77-47dd-bd99-043b3964b2a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7e8b3c71-8696-4148-8cb4-ff3a7d51062e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-05T17:27:57.0697746+00:00"
},
"company_sector_id": "8fa6a223-78a6-462c-b981-6607da11a1fb",
"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": "51d34d4b-95b3-4275-87a4-dee8d5de5ae2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "570b8cac-e880-4597-ac4e-56b25dda5e47",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4e0374d5-87b8-4e2f-a889-fb6627d40435",
"account_manager_user_code": "sample string 56",
"company_status_id": "50577128-a446-45bf-912b-e6f95469b9ad",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-05T17:27:57.0697746+00:00",
"id2": 60
},
"db_language_id": "4fa1e0f3-c16d-4059-a29a-d03538feead9",
"db_language_code": "sample string 7",
"db_title_id": "bdd30700-4a03-434b-bd73-26a6e9fccf5e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-05T17:27:57.0697746+00:00",
"create_date": "2026-10-05T17:27:57.0697746+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-10-05T17:27:57.0697746+00:00"
}