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": "0d03dfae-7c1b-484f-966c-aec9bff70810",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f33a681b-b7b4-4f70-a441-71b14d3c2854",
"company_code": "sample string 5",
"company": {
"id": "030b512f-0035-45b1-a6ba-1fc375e172bf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-12-01T15:04:19.2174784+00:00",
"sales_territory_id": "4b840367-373c-4333-a682-fd5a64494b09",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "39e7b2ca-0c59-4167-9114-fffec73d572c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "197e123d-4031-4682-b419-06b33469087a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "159b2657-2352-4b5f-a163-3501f37de4d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb76d475-147e-4d5f-a0f4-23af98227f39",
"db_currency_id": "61f8b98c-6564-4660-a1b3-e4ce2ec19963",
"db_language_id": "eb389bbf-da51-43d4-9ca1-3a05fcc5162f",
"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-12-01T15:04:19.2174784+00:00"
},
"modified_dateutc": "2023-12-01T15:04:19.2174784+00:00"
},
"marketing_segment_id": "b7c452ee-5cef-4a02-af3d-4fc471c334d5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "79268976-999b-47fc-9a46-8fa0295ba468",
"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": "250aa5c0-6ec3-45a3-8aa0-32474819b716",
"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": "5042f7f6-d48b-48cc-9f41-c19e5575bf02",
"db_country_code": "sample string 28",
"feelist_id": "8c8b4fe7-9368-41f4-9584-b66787b7ace0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5afbe692-a1e2-4d70-bccb-132059dfa76a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f9cc7b93-0c32-4511-9a10-84d570157d98",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-12-01T15:04:19.2174784+00:00",
"db_currency_id": "7fd5f1a2-0fd6-44c7-98f3-916633013200",
"db_currency_code": "sample string 10"
},
"company_type_id": "b21e7752-74aa-4d51-960d-2ca75fede88f",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a50f4c8-18c7-4e3f-8865-8b818f0f6ac7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f7ec5abe-f015-4876-a21e-18b783eadf81",
"sales_organization_code": "sample string 5"
},
"db_language_id": "18bd31ed-b148-4593-9a5b-dec72c56efb7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "64df23d7-8239-400a-976a-2c07de9ebe90",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "afdb6bff-a76d-41b2-8808-959620b85d1b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1925ecde-811a-4a9d-866f-ef791fa68e84",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-12-01T15:04:19.2174784+00:00"
},
"company_sector_id": "c63129cc-8dbd-4d56-ba41-8d7e1b5b3192",
"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": "fda6902f-6732-4c35-b60a-fdf5f0b8bea7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "232abd77-0a4b-4a5c-a99b-64144dd91c83",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b4a677fe-4f53-4d43-a4d3-16596d6d3a5e",
"account_manager_user_code": "sample string 56",
"company_status_id": "faf03916-3960-4352-b992-ae8c630a727f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-12-01T15:04:19.2174784+00:00",
"id2": 60
},
"db_language_id": "55dad3d5-5cb5-424e-bf4d-015eae889935",
"db_language_code": "sample string 7",
"db_title_id": "d612176b-8992-45c5-b4c4-3e1bf12cc1a4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-12-01T15:04:19.2174784+00:00",
"create_date": "2023-12-01T15:04:19.2174784+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-12-01T15:04:19.2174784+00:00"
}