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": "4062b9e9-47e7-4291-9405-7aa78d2e9003",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "22cda62f-d2d5-4859-b45a-ad7ca456323d",
"company_code": "sample string 5",
"company": {
"id": "00bc3714-e03f-408c-bd78-1a601b9d848e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-27T16:32:52.0366704+00:00",
"sales_territory_id": "93c736b4-5bce-4a19-b938-16f9906b796f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7054aa6d-929e-4cf5-a2d8-d652cd03ee1f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ee8016c7-cc5d-4df5-ad02-e83ae7f7ff10",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4dadd5ea-a3aa-4530-8ac6-d42eb23d104e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42d42c6a-b914-4c9e-b0e9-03c6bc0b6ad3",
"db_currency_id": "3493e8e7-37cc-44fb-ba95-5f7cf8474286",
"db_language_id": "72018f91-e144-431e-ba04-d2a9a8f1daff",
"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-06-27T16:32:52.0366704+00:00"
},
"modified_dateutc": "2025-06-27T16:32:52.0366704+00:00"
},
"marketing_segment_id": "eb3c159b-7d11-4006-8a82-73496609e892",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7df036ef-9cfa-433c-a239-8cc04ee3563a",
"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": "73fde198-f533-42cb-b3df-d14baf029fe4",
"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": "da0716aa-17c1-498a-8f81-9432a05515fc",
"db_country_code": "sample string 28",
"feelist_id": "9a1a17d7-3329-4e98-834f-a146d70f5ba4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "95c38f76-7937-4b9f-80fb-e74b385950e1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ea100054-9bfa-4a92-8507-a2c4607f6ba0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-27T16:32:52.0366704+00:00",
"db_currency_id": "82ceb067-9685-4a15-b9bc-1898116de6cc",
"db_currency_code": "sample string 10"
},
"company_type_id": "8b956329-34fe-4d36-b035-62e71cbb9de5",
"company_type_name": "sample string 32",
"company_type": {
"id": "7951654b-69cd-4082-935b-fbd90ebe1e33",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b17ba10-f0c0-4843-9233-178f6c2cc4c5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f3ae4e84-cd13-4e25-9f34-0240db90246e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6c834547-cc94-47e2-8240-9578eb81a5c5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "637163d5-bfb4-4629-ba3c-7f2f6fc1b557",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c7366bd6-b611-4d9d-a461-0162e5fc1d05",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-27T16:32:52.0366704+00:00"
},
"company_sector_id": "8fb8a2bd-6fc2-40a1-834c-a7b550e6eea1",
"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": "e1366195-8781-4e56-98cd-e11dfc8fe32c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f2103dfc-5d7c-4c0b-8334-a89ae61aee3b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f2bf7f17-384b-4a36-9559-91f8980c525c",
"account_manager_user_code": "sample string 56",
"company_status_id": "0ee91e55-eab8-4723-9ea4-85c6cecd1f6b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-27T16:32:52.0366704+00:00",
"id2": 60
},
"db_language_id": "e4bfbacf-c2ad-40fb-875d-6dee02a7a5a0",
"db_language_code": "sample string 7",
"db_title_id": "a99e3f6d-2100-4fad-9f69-98ae7234af4a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-27T16:32:52.0366704+00:00",
"create_date": "2025-06-27T16:32:52.0366704+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-06-27T16:32:52.0366704+00:00"
}