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": "b5622e38-e6e1-4367-a100-e9300c3ae2fd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dae9a456-dbb9-463a-b7d9-73c7420d128a",
"company_code": "sample string 5",
"company": {
"id": "1e70eada-cd7a-4263-9923-e645d5fba93e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-06T23:31:35.3160854+00:00",
"sales_territory_id": "14e4dd69-7696-4907-9519-061a4fd2fbcc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "24888a30-96c2-42bb-ae17-db2b34b7551a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bd5755d6-0add-4564-9aec-7a6718dcf058",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d38a2f97-2bbe-4d6d-ada4-326eae18d866",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a56a9885-153b-4364-9032-1d0341c78aa3",
"db_currency_id": "52e6abe9-c363-4457-9e5e-1ec0e80d469d",
"db_language_id": "bee23c76-9e01-454e-92b9-45a4c2b0eccb",
"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": "2026-03-06T23:31:35.3160854+00:00"
},
"modified_dateutc": "2026-03-06T23:31:35.3160854+00:00"
},
"marketing_segment_id": "6181bbbd-b685-4ad2-97da-ba5d06e4cfde",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5b96f443-7b79-4901-acf1-2f48ad2b539e",
"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": "6291dc9f-8be9-4c5b-970f-0294dae49c61",
"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": "4d8a55ce-2d7f-4103-ade6-14bc62697a5b",
"db_country_code": "sample string 28",
"feelist_id": "3af49275-af09-4352-adeb-b068218c9467",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "51681db8-16a5-46e4-a9a1-024ccf283c50",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d35eb31d-5c7a-4331-acdd-5625187c677e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-06T23:31:35.3160854+00:00",
"db_currency_id": "226a6828-ffe8-49ed-a8cb-a4eff5b7912f",
"db_currency_code": "sample string 10"
},
"company_type_id": "5cb5f9df-a982-4f5b-be3b-d552828938c1",
"company_type_name": "sample string 32",
"company_type": {
"id": "e1412620-8b86-4230-97e0-5b6a46d5c015",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "03f0ee89-a397-48b1-b75b-11631fe34e03",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a6e498a2-bc93-4a1f-a44b-c553bea91a3e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "74e0492b-6adf-4b30-82a9-1ed33345314c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "af8a99d4-d785-40dd-a43b-9fafdbf964e1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ba185221-a845-45b9-8b2e-892b06426cd9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-06T23:31:35.3160854+00:00"
},
"company_sector_id": "fdc3e985-8b5c-4d5b-afaa-d2e1e3fd7d46",
"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": "18f3c829-6595-4958-a142-1b1e35d85a4d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "05b9ca21-58b2-4661-a889-e47ff7cfa754",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "89114bfb-5d20-47f8-8d88-4bdc215d961b",
"account_manager_user_code": "sample string 56",
"company_status_id": "dec960ce-648f-4a87-b6f0-2fb296ffedcb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-06T23:31:35.3160854+00:00",
"id2": 60
},
"db_language_id": "a4f462f3-a2e0-4a03-9a6c-1f914c0bb33e",
"db_language_code": "sample string 7",
"db_title_id": "1839f485-d86f-4c5f-a9a3-3fe11e059989",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-06T23:31:35.3160854+00:00",
"create_date": "2026-03-06T23:31:35.3160854+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": "2026-03-06T23:31:35.3160854+00:00"
}