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": "31761efc-e3d6-4977-a6b2-f921f6d9c9a9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "538d228f-23e5-4ced-af1f-5a85d4659bcd",
"company_code": "sample string 5",
"company": {
"id": "23357e0d-1cad-4b9c-9b24-9738619dc0ba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-05T03:48:40.1627208+00:00",
"sales_territory_id": "fe0fd76c-f214-434a-ae45-09781fb95781",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1c46fc8c-7221-4e22-a26f-2d75e7b8e907",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "20c61014-a89b-4ec8-aeef-dbfec5f3a609",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a1a7504-8b6a-474f-b6d0-658f82d40a93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f943232-90c9-44c5-a09d-38b42c5144ae",
"db_currency_id": "2a08ec33-c656-404e-87e7-b06ad3f5c7f6",
"db_language_id": "f0de203f-c378-4b5a-a017-12034490ced0",
"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": "2025-12-05T03:48:40.1627208+00:00"
},
"modified_dateutc": "2025-12-05T03:48:40.1627208+00:00"
},
"marketing_segment_id": "c118fd2b-7735-446b-9392-c257000a0a68",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "da845f59-fbee-452b-9090-2d84c799bf16",
"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": "e00133bb-d7c7-442c-9759-54aa95a054ef",
"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": "cd4ef91d-1b79-4294-8980-5aa044900d3a",
"db_country_code": "sample string 28",
"feelist_id": "eec38f0f-b430-4b5c-b641-c5f46d19eb8e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1acd5fa6-dd24-48ca-bf07-4fdec2c1bec9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "aa21be05-d06c-478a-9c77-4a7ccb9b99c6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-05T03:48:40.1939706+00:00",
"db_currency_id": "7f99d8b1-c4a8-482d-8490-3541413136e1",
"db_currency_code": "sample string 10"
},
"company_type_id": "2d860514-92dc-4967-932e-07060ccaa712",
"company_type_name": "sample string 32",
"company_type": {
"id": "2dc27def-50ad-4e3c-8668-3150aee48bf5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "480d468b-d35a-40a8-b82e-2eca2ff29282",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d4037515-79fe-47d2-9660-caae8a602041",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "af7a964c-d53a-48b8-bfd2-42ebdc22f1bd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "55e517d2-04b3-453f-8fa4-15dc5dd40c5f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a72f4c37-8ddf-4691-9d8c-cac887991b5d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-05T03:48:40.2095976+00:00"
},
"company_sector_id": "3e34ed38-f1ce-4d51-b302-0a73adb63d3f",
"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": "4539522c-cc66-45d0-87df-fc3222e1444d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "de741713-40b2-4a58-b78d-b53e74959c6b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ec42101d-b5d4-4abc-96cd-08e4f4ecad66",
"account_manager_user_code": "sample string 56",
"company_status_id": "a7308781-0e5b-4947-a7c1-4241256d93e5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-05T03:48:40.2095976+00:00",
"id2": 60
},
"db_language_id": "983943f3-bf89-4f1b-9e30-c2abbdf44c0e",
"db_language_code": "sample string 7",
"db_title_id": "9ea29efd-d124-4e5c-a416-965c256af9e1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-05T03:48:40.2095976+00:00",
"create_date": "2025-12-05T03:48:40.2095976+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": "2025-12-05T03:48:40.2095976+00:00"
}