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": "9d9b49f9-d032-4970-9f39-81912493e316",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6578ceee-aaa1-490c-841a-350c1f9287cd",
"company_code": "sample string 5",
"company": {
"id": "0f4e4e3b-8941-46d4-ad07-34b27cbc4923",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T10:04:22.6643392+00:00",
"sales_territory_id": "88937bf8-ed56-4904-beed-e985e5f66b4f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a6be0be3-40e2-4ad2-829c-bb6b7416ed6b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c945b5a0-fa1c-4779-98d3-667ae1aeb9a9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c97b8a0-5bfa-410e-9daf-f82663eb09cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9d1bbc8-84be-4791-ad43-156bc66a6144",
"db_currency_id": "7afee54b-4c38-4173-8126-f9c78478cba4",
"db_language_id": "aad36a17-e2b5-4952-bfd8-5bd737e8a0cd",
"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-11-21T10:04:22.6643392+00:00"
},
"modified_dateutc": "2024-11-21T10:04:22.6643392+00:00"
},
"marketing_segment_id": "91757b91-ca46-4f20-9a2e-4b8dc617e597",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "27b8626a-d47a-41ba-b47e-e6da269ff9f6",
"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": "198257a3-57e4-47f7-b328-fee164a8490c",
"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": "c109078e-3733-4e60-a5ce-bc33b893be94",
"db_country_code": "sample string 28",
"feelist_id": "996084ee-0b94-4a1f-adea-b747edcec7af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bdd99351-2e0d-447f-b846-8362d8bbb471",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "32598ebf-8967-4410-bc03-8976418acff2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T10:04:22.6643392+00:00",
"db_currency_id": "424f6dd0-14ec-41e5-83d1-71fa5bad03d8",
"db_currency_code": "sample string 10"
},
"company_type_id": "81494d41-bd02-43d8-8ddf-377f9b166952",
"company_type_name": "sample string 32",
"company_type": {
"id": "bbe1001a-96dd-4d88-9fd7-4900b618e2e0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b7c78201-0bab-42f5-9f60-c9c8ef0fd52d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a884b07d-03cb-42db-abea-74162efaba7a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bb6bf60c-c746-4710-9f8e-496285548487",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bed5e067-7b90-4cfa-80cd-dd8fb67fe1ba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "20843451-32f0-443d-9aa6-2c7236158fb6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T10:04:22.6643392+00:00"
},
"company_sector_id": "6dbe14c7-9c23-4062-8c48-37dc4f0e0e70",
"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": "7ce12101-167a-45db-bb62-69aeca18991c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "df83d6a8-9aa2-4e27-b922-4fe283c78c93",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "80de4fe9-370b-494c-8f4e-e0396e92fa58",
"account_manager_user_code": "sample string 56",
"company_status_id": "736fb976-849c-4908-9c59-1964cbca43f1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T10:04:22.6643392+00:00",
"id2": 60
},
"db_language_id": "5a725039-4294-4b2a-92fa-23cd0d4462e4",
"db_language_code": "sample string 7",
"db_title_id": "5bde39ec-79a8-49a7-b4cd-13a3b77e62da",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T10:04:22.6643392+00:00",
"create_date": "2024-11-21T10:04:22.6643392+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-11-21T10:04:22.6643392+00:00"
}