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": "c4ddf139-4d23-4baa-aab6-15548b40fd8d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "52feccc6-675c-443d-aa1b-09303be94ede",
"company_code": "sample string 5",
"company": {
"id": "32e998e9-f033-4ecb-9c48-a015678206ae",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-22T13:49:49.356111+00:00",
"sales_territory_id": "246c78b5-e43d-4d04-8062-e16428fc699c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cb9b4885-e045-4bbb-a268-8060e85fe3cb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e13213c-5399-4429-aaaf-15296c595288",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8562aa4-1c6e-4e08-9779-7f21be14f994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "60438332-efe3-45e0-aeef-9a15bdce914f",
"db_currency_id": "733a3b1f-f251-474a-831c-1596ccef855e",
"db_language_id": "69cca6c7-125e-4c79-a28f-f97f13be0118",
"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": "2023-03-22T13:49:49.356111+00:00"
},
"modified_dateutc": "2023-03-22T13:49:49.356111+00:00"
},
"marketing_segment_id": "e3e347de-e2a6-4c77-8cc5-361613a2854d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d9e31a4e-f0b1-47d8-8082-de3bb520424e",
"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": "1ac10307-88d4-4b4a-ad7c-4b82fc9ad5da",
"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": "3e1acfc8-97f8-4c7a-871a-2eecfaed654a",
"db_country_code": "sample string 28",
"feelist_id": "451490ee-45c8-4a99-a6a8-c2e2065a4fd2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "83a321d5-d464-420f-b25d-503f6eefbd93",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ad6ba98e-b38c-4611-9ef6-ba16287588f1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-22T13:49:49.356111+00:00"
},
"company_type_id": "ce43ddb2-c062-49c5-840a-6359f14c6e68",
"company_type_name": "sample string 32",
"company_type": {
"id": "6fe8841e-7877-40de-b297-7733d739ff40",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "96a2baa8-2ab5-432c-8355-48141e5d7f6b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "87ca8e31-66dd-4e52-ae3c-91dee640cfed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4c0ac64a-46b9-47b9-9b78-0e2582a3b690",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "67ad294d-f137-4f11-b318-d20fa1609f9f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad287da2-d22d-4316-8300-b3444928ca5c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-22T13:49:49.356111+00:00"
},
"company_sector_id": "be891321-8737-4eae-910d-22158d83d93f",
"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": "e634d35a-ca12-44f7-973a-88e03f7189c9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "29162c21-d180-49b9-af12-dd2c34fc4081",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d2034ebb-35b5-492f-90df-d6bbcc150580",
"account_manager_user_code": "sample string 56",
"company_status_id": "c44f0823-f288-4235-bdf7-712b6679a89e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-22T13:49:49.356111+00:00",
"id2": 60
},
"db_language_id": "4b9e2aa8-311d-4e0e-968d-59a178b0018f",
"db_language_code": "sample string 7",
"db_title_id": "6b3250b4-a268-48e6-9e4b-fa76d953c1b4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-22T13:49:49.356111+00:00",
"create_date": "2023-03-22T13:49:49.356111+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": "2023-03-22T13:49:49.356111+00:00"
}