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": "e6aa4685-f6c8-4c3b-9fec-310737030781",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6a633037-954a-4354-8a4b-421dea1ff7fa",
"company_code": "sample string 5",
"company": {
"id": "cb3e64dc-64d7-4ea8-9b9f-c5a30d715b07",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-22T19:01:35.1330097+00:00",
"sales_territory_id": "d818f6ef-38c5-49e5-8218-8cf6810496a3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "33238dde-7ceb-4e41-98e8-492f28e5a250",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bc75cff3-dc36-4309-92da-81f768b3ec67",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "30079d67-3e9e-4c62-a9b6-298cd8b8f7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2dff764-40a5-4017-8620-0dbfd0eb462a",
"db_currency_id": "46d91960-64a9-4bd2-b6a0-c2fcfa432016",
"db_language_id": "8f0ddd62-20dd-4c13-b9a8-1fbb7eb5d760",
"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-12-22T19:01:35.1330097+00:00"
},
"modified_dateutc": "2025-12-22T19:01:35.1330097+00:00"
},
"marketing_segment_id": "ea104b17-34b7-4e66-ad3c-b481dbcbf32e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "acc52d1d-223a-466e-91c6-4aa61cf7b19e",
"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": "9b36e5d7-56c6-4391-b4ae-a0075f89f84f",
"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": "482b7099-977f-4136-93c9-9eab7aacb844",
"db_country_code": "sample string 28",
"feelist_id": "26d1d94c-4b00-4aab-9a2f-865fc0a8ba24",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5e62f068-e404-447e-9d66-ae1ed0ec4007",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "62d9f949-691a-499c-a145-8de54dc728d5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-22T19:01:35.1330097+00:00",
"db_currency_id": "944db65b-276e-4c33-a3cb-6f267d73864a",
"db_currency_code": "sample string 10"
},
"company_type_id": "69b98a84-6f26-4d30-9280-a68a2c05f8d7",
"company_type_name": "sample string 32",
"company_type": {
"id": "92749d12-d52c-4fb8-a6bd-feb665ef56a3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8149dca-5053-4ac8-b6cd-358a77700623",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0a5b97f8-c3fe-428a-9e32-899ce2940c8f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "67ad5fad-0e60-4386-af96-e934f6d0617d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e416b759-018e-4f18-9cc6-f09b8e803298",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bdb9d4b8-b7fd-4670-8898-c24af153d43e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-22T19:01:35.1330097+00:00"
},
"company_sector_id": "33a8d481-5430-42b1-b80a-2786227cfa37",
"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": "4700462a-0ff3-4407-96bd-95649cc8c368",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "be2b5023-58b6-4c26-9dd2-0dffc7c75281",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a2a9bdfc-c8a9-4513-a147-adcabfcc0d4a",
"account_manager_user_code": "sample string 56",
"company_status_id": "da3e140f-606e-42fb-8e69-59905c06a113",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-22T19:01:35.1330097+00:00",
"id2": 60
},
"db_language_id": "27700cd5-2c69-40f5-a14f-8b6841b94b6c",
"db_language_code": "sample string 7",
"db_title_id": "a9e8cbc7-a3f3-4f8c-9e52-076f3be224c0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-22T19:01:35.1330097+00:00",
"create_date": "2025-12-22T19:01:35.1330097+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-12-22T19:01:35.1330097+00:00"
}