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": "4f15d2c2-5dc8-4e12-bf6a-3774cd7b520f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7340763e-b213-4bb8-b1a4-6dbe6bd3063e",
"company_code": "sample string 5",
"company": {
"id": "9ebb6a52-8f0a-4fcc-b86c-e425ac599792",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-13T04:06:07.9373403+00:00",
"sales_territory_id": "2c2c5c83-6a74-48fa-88ba-941a50ce2461",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "82ba13bb-6790-4cd4-a8fd-7b6540cd300b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2f079152-910f-4c70-aee4-0558bddd1af2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20a1c5b0-f287-46df-8178-b423fc72816b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f4fa387-339b-4849-9ae4-68bcf369642a",
"db_currency_id": "af3cb57a-9877-490b-8476-bb01e230fd39",
"db_language_id": "069114b6-345c-44d4-ac53-b617c88ce612",
"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-13T04:06:07.9373403+00:00"
},
"modified_dateutc": "2026-01-13T04:06:07.9373403+00:00"
},
"marketing_segment_id": "b35979ab-f3f0-4388-bb43-c99b1be43ed2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e355ffba-06e5-405f-93a4-161f10d9ff71",
"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": "de37db56-f141-4ced-bbc3-0f7eec035a0f",
"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": "9a0c1326-d8cd-4c20-8ec4-de4859d17e05",
"db_country_code": "sample string 28",
"feelist_id": "75b84b63-da05-4917-b3c3-0e63fabd9c1c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "58523a1d-3587-4d98-a666-ddd0b71dcd5d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bedf6fdb-b9ee-43e5-93e5-ddd7c4494e40",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-13T04:06:07.9373403+00:00",
"db_currency_id": "fb4ce551-0256-45ef-8df5-7194c2ff870f",
"db_currency_code": "sample string 10"
},
"company_type_id": "78e507e9-b7dd-4a8a-80fe-4849bfd32484",
"company_type_name": "sample string 32",
"company_type": {
"id": "f85b2a7f-09dc-4ebe-8658-5c9649257c7c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ca4bdfaf-10ac-40a8-b518-73b54a3ddde4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "81396872-2933-4168-8f1a-a21c35142cc4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f6cf58e1-2ce7-426a-be7a-bcae5bc10584",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5377e2ec-eae0-4d4c-9a3f-243bb8113df5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "97d3336b-11fa-4c62-93da-f232f459b105",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-13T04:06:07.9373403+00:00"
},
"company_sector_id": "9897d762-7231-49ff-8e6e-1a0f469381a7",
"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": "f4132c39-ba92-42e7-b711-486db8382484",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "449a2a91-0a17-4721-a3d9-5060909b3a3b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eaaac834-58a9-42e4-8b43-ed9cf0a07cc6",
"account_manager_user_code": "sample string 56",
"company_status_id": "24dd4ae5-02e6-48dc-a28e-f8afbe464320",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-13T04:06:07.9373403+00:00",
"id2": 60
},
"db_language_id": "a0af1f26-d662-4dc8-b396-681feffc25ff",
"db_language_code": "sample string 7",
"db_title_id": "4a2c3c73-f444-4792-98ec-2dd8b000c514",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-13T04:06:07.9373403+00:00",
"create_date": "2026-01-13T04:06:07.9373403+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-13T04:06:07.9373403+00:00"
}