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": "ce998adc-5660-495d-90cc-6437965b5d93",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "39412799-37a1-467f-9dff-ea55df503ef0",
"company_code": "sample string 5",
"company": {
"id": "94874c44-345b-4efa-bc9a-5c7ef2446633",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-18T01:28:23.9812839+00:00",
"sales_territory_id": "bbdcc163-bd02-4d81-a528-e68aa5de9368",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a7009f01-a17a-4472-903e-32d1e505c274",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5bc01db7-8825-4383-ab29-de9d9003e6a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "151b6618-ea8f-4c1b-aa7e-0ddc28a42205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a6c3387-c417-43ec-8388-955a77dcb047",
"db_currency_id": "32f6faff-6dc5-4f27-9f04-ea601b060150",
"db_language_id": "fca5f89e-5106-4c73-a1e7-8b31631ee13c",
"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-05-18T01:28:23.9812839+00:00"
},
"modified_dateutc": "2025-05-18T01:28:23.9812839+00:00"
},
"marketing_segment_id": "51aa63d2-afb4-44a8-a67f-0b9b8c4b78ad",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0fecf212-15a1-42cf-9759-f148bd731d0e",
"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": "6ed2615c-cb47-4b58-a889-e73a18658337",
"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": "8e35faa3-80c4-4e53-814f-bafe6e9aa235",
"db_country_code": "sample string 28",
"feelist_id": "28a8d600-2b14-43b4-a42d-4935755031b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "63d5e879-5528-4d29-b924-6d065738bdb4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5df2a449-a25c-4096-8de8-0a3f3ad8c244",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-18T01:28:23.9812839+00:00",
"db_currency_id": "812eed6e-e3c1-41eb-81d1-e476c3652ba0",
"db_currency_code": "sample string 10"
},
"company_type_id": "e35f9794-a576-4cb9-8894-996e31b0d38a",
"company_type_name": "sample string 32",
"company_type": {
"id": "3aa36d52-4ee5-4c6e-9eba-02eb86a2b3be",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f7ad118-6a25-46b8-b649-36271a7de61c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e0ffb855-6b5e-4e6b-8d23-7ecf570a73d7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "233aaa45-a453-4ac4-bc28-33ae80a94185",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b05c8c91-096f-4bf3-a965-5ff729a1e911",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "89e7d26c-5469-49a5-aedb-7f326d8d62ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-18T01:28:23.9812839+00:00"
},
"company_sector_id": "30a65226-c635-409c-9aeb-68ef1eae2263",
"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": "2c1fbaab-2866-4b32-bbf7-84a668f98d2c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a2c104c3-2f6e-477a-9a99-38c378976e04",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "853ddfe6-87cd-4d65-8e67-50e7bf25f61a",
"account_manager_user_code": "sample string 56",
"company_status_id": "c7bed4a2-e940-45ed-b633-2187f28a5233",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-18T01:28:23.9812839+00:00",
"id2": 60
},
"db_language_id": "a70760b2-f813-4b14-8768-c590c4373692",
"db_language_code": "sample string 7",
"db_title_id": "ebc03edf-f573-49f7-93a7-4182f3db5561",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-18T01:28:23.9812839+00:00",
"create_date": "2025-05-18T01:28:23.9812839+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-05-18T01:28:23.9812839+00:00"
}