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": "e020eb10-f88c-4c7a-a1d5-a57058c8d248",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a9cacef3-107f-48b6-881f-7ce3566ed2e9",
"company_code": "sample string 5",
"company": {
"id": "393f39e0-dd13-44af-a6c5-7c3992a45ec0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-07T04:26:59.1247977+00:00",
"sales_territory_id": "43a71ca1-9df4-4a89-b600-07d59b832b6b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "680a59b7-1162-4468-8665-060454a23131",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36ccb265-aa26-4598-a3d1-9a85dbe3d820",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "93ae7f55-f9d1-43fa-b4c6-ed417312b5da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5a1e92b-5b0e-4cba-af0f-b29e2d863aca",
"db_currency_id": "a94bf5df-1265-4f27-854d-ed237c028c15",
"db_language_id": "443195c7-95be-4eb8-9b86-d5b988e92e63",
"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-05-07T04:26:59.1247977+00:00"
},
"modified_dateutc": "2025-05-07T04:26:59.1247977+00:00"
},
"marketing_segment_id": "49c7d033-7df4-4cfa-8aa7-627718e7c78f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0b843e4e-3a13-41ef-bb12-c17501e2e765",
"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": "0a54ed13-4d10-4fbb-a592-d45c8b677708",
"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": "328a6d8c-cc12-4aee-b769-d102df6724de",
"db_country_code": "sample string 28",
"feelist_id": "0f28ca68-9def-4fd8-84fa-3fc6c2d99440",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "061606ae-4ec7-4ef4-906d-ff8759bf56a4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6b0cfb41-dc29-4f60-ad4c-7fc9e2c4ae5a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-07T04:26:59.1247977+00:00",
"db_currency_id": "ed8bd024-2a3a-45b3-8005-4ca1a943b3c0",
"db_currency_code": "sample string 10"
},
"company_type_id": "e814654a-7953-491b-a383-f2668cc9f51d",
"company_type_name": "sample string 32",
"company_type": {
"id": "e8f8c471-1031-4a6c-9064-53c68bbba7cc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11d64524-655a-458a-b507-717c3720b6e8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "748b08cb-f5da-41d0-8710-47fe9fd1bd92",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d470b9f1-0d4e-4e1b-8fa9-766c8a674254",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "29231283-3e75-4278-9049-a55898b218e4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "33e57000-8d10-4b1a-a02c-b5996f8cc2bc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-07T04:26:59.1247977+00:00"
},
"company_sector_id": "a137985c-b8da-4605-9a25-99a4fdd10723",
"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": "201b4719-ef4e-496f-9067-b55ce758e0b4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "899fd6f2-313b-4f5c-8db1-890c621757c0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9b45f8c8-b0d5-4956-a6c5-5cddfe7454a4",
"account_manager_user_code": "sample string 56",
"company_status_id": "fa379ecb-9ae2-4173-9932-bac2ab1cbd14",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-07T04:26:59.1247977+00:00",
"id2": 60
},
"db_language_id": "93081d1b-36ff-4567-a22d-a31ecbaccaf0",
"db_language_code": "sample string 7",
"db_title_id": "a98995e7-66d5-4b51-9bce-80a1e367c569",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-07T04:26:59.1247977+00:00",
"create_date": "2025-05-07T04:26:59.1247977+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-05-07T04:26:59.1247977+00:00"
}