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": "9e5bfd04-532e-4a53-bf6e-21ceff9dab50",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c2eb9429-093e-45e9-bd7a-31a5356b8187",
"company_code": "sample string 5",
"company": {
"id": "f91ac616-00dd-4e4e-975a-85b8e44d5440",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-21T17:13:17.3639763+00:00",
"sales_territory_id": "e5e0f23a-6115-45e7-8b4a-af73194c2c47",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dd11676b-0f52-4a6f-b728-248e81b86a90",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "71becad5-4c3e-47d5-ad2f-5b6d560fd1c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "84b34401-943f-4967-a88c-f555979de16f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b62161b5-092b-4a8a-a8f9-68644a797664",
"db_currency_id": "b9f2a7ca-848b-47e6-b23e-7bd5dc7466d1",
"db_language_id": "f292ee39-6ca7-4e6c-bc50-fe066be70449",
"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": "2024-12-21T17:13:17.3639763+00:00"
},
"modified_dateutc": "2024-12-21T17:13:17.3639763+00:00"
},
"marketing_segment_id": "ab79e877-f1d0-4979-883c-f379e751501c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "088f055d-49c8-4332-8c85-79a9b7446303",
"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": "0b8e834a-1051-4692-ad1b-bf1d8d80904d",
"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": "a702718e-eeab-40d1-b5c4-cbb60fe862d0",
"db_country_code": "sample string 28",
"feelist_id": "d4995f81-bc3f-4143-b60b-dbf79f771c4f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "71aed029-6177-4018-987c-052b467bb006",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f08f347c-3804-426e-a154-a00f7ddb4e54",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-21T17:13:17.3639763+00:00",
"db_currency_id": "0e71ab6b-5f76-423f-9ff2-38b15c80bf57",
"db_currency_code": "sample string 10"
},
"company_type_id": "64e474c2-8dcf-4eec-8d56-990fefe71dfa",
"company_type_name": "sample string 32",
"company_type": {
"id": "6e84e06e-f029-47ee-8549-dd86614a9edf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5951fd0d-e1ac-4764-a499-8c6131d2ca06",
"sales_organization_code": "sample string 5"
},
"db_language_id": "61276178-b103-4a79-887d-9b921f784a93",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "beac947c-48e2-4c7c-96f7-21e200b946e6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b0d57350-629c-47fd-b0ff-657383a89a51",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "38a9e21b-81a4-4676-991c-9cb628a02aee",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-21T17:13:17.3639763+00:00"
},
"company_sector_id": "bf903fd5-e512-4912-a277-535c0f2852d5",
"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": "bf509344-6b1d-4246-987d-f7307bc3cbdc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4f5c627d-72b7-4f44-aa4d-86ad826086e1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "33f40bcd-5fa4-473d-9367-55bfeab0367c",
"account_manager_user_code": "sample string 56",
"company_status_id": "30089480-91f0-432a-aa65-39545dfd5072",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-21T17:13:17.3639763+00:00",
"id2": 60
},
"db_language_id": "44fd6413-19fe-4a4e-a80a-44734a61305e",
"db_language_code": "sample string 7",
"db_title_id": "37a55c0e-5c37-4e6b-a053-a3c42de02a5b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-21T17:13:17.3639763+00:00",
"create_date": "2024-12-21T17:13:17.3639763+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": "2024-12-21T17:13:17.3639763+00:00"
}