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": "5b6b5601-285b-45ab-b936-b316acbf8a94",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9d1ce845-4836-437c-87dd-69bbc1ae8912",
"company_code": "sample string 5",
"company": {
"id": "a29f7be4-2b3c-4d27-8d47-aec922d318f5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-23T11:23:41.0263041+00:00",
"sales_territory_id": "d91b3ee4-2716-4aa0-8ff4-95922cde9149",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ea4f0f4b-952b-4d6a-957b-adb0591c24f9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f480f5c8-e62d-4864-be69-d0e336ea4b0f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef087b8d-60f6-415f-9f55-fdd456d5701b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85d7b7da-c6b8-4e84-b8ce-9cde05cb8bf8",
"db_currency_id": "9e95c849-a430-43e6-b65d-f62287ec5cef",
"db_language_id": "29912716-7762-48f1-89cf-4f070d1ed327",
"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-09-23T11:23:41.0263041+00:00"
},
"modified_dateutc": "2026-09-23T11:23:41.0263041+00:00"
},
"marketing_segment_id": "b1bc4479-59ea-459d-b565-3a5a164743da",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "58853692-a59d-4a4e-918d-70590d2c8b7e",
"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": "28822268-4ae8-4471-8530-46ca44b8489f",
"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": "ce4f89e3-fead-40f0-a640-217fa121cb7b",
"db_country_code": "sample string 28",
"feelist_id": "f5aedafe-1297-4ddb-83d7-aaec76700bbc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c2a49e78-7056-428e-843e-0f9131e9e092",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "96850beb-aca2-42eb-a4c0-94ec0d05563f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-23T11:23:41.0263041+00:00",
"db_currency_id": "69f1e40f-331f-4f76-8e9b-b071a5f19b6f",
"db_currency_code": "sample string 10"
},
"company_type_id": "0b04e527-fb2d-4e25-89e0-bac0c829d553",
"company_type_name": "sample string 32",
"company_type": {
"id": "8ef8b9ae-e631-49d5-a085-af1b4bebba36",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "17969a9d-895a-4ebe-b8d9-9f679c00b65d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7c226a3b-f08b-4452-9ac3-0ce9f7a95aef",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "44f8fb89-cd2c-4453-a50e-42be27fc831b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "993ba3d0-d0d8-4f34-956d-dec7c6ea9da6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f852f250-73b2-46fc-97d2-534c4ec95abe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-23T11:23:41.0263041+00:00"
},
"company_sector_id": "638c0c72-f865-4138-bdef-e88be9b87d72",
"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": "6044103f-c4a8-4b19-8df5-a1640949684f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e46cee41-5ce7-4d37-a72d-ef244d61b53a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bd1ebd88-e521-499a-a1f5-f4c01667c970",
"account_manager_user_code": "sample string 56",
"company_status_id": "4e3ec7af-189e-4b6e-a938-8ff4d9726b8e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-23T11:23:41.0263041+00:00",
"id2": 60
},
"db_language_id": "1bf8e6fd-ae8f-447d-a7c8-9ac4ea00dfdf",
"db_language_code": "sample string 7",
"db_title_id": "e988ffbf-17c7-4bd9-92e5-7b6f6e1e4e64",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-23T11:23:41.0263041+00:00",
"create_date": "2026-09-23T11:23:41.0263041+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-09-23T11:23:41.0263041+00:00"
}