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": "9ff1f185-dc24-42ca-9907-d1582609dc33",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "425f63f6-f082-4262-8398-8c47234e294a",
"company_code": "sample string 5",
"company": {
"id": "2d4ea7c5-b456-47fd-ad85-e0d7bc43a830",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-15T04:14:57.2412109+00:00",
"sales_territory_id": "bc10c786-0984-48ce-9ee8-e9d515c287ce",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "df90190b-5d7b-4b50-b8c1-f6e87455836e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b412b940-6e54-4229-88ab-37b25086531b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e5f19e01-f66a-4146-bd5f-bb9cf73db0c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcb349f5-f265-46e2-90a6-368d448307b6",
"db_currency_id": "775f1d8c-8adf-425a-b5f0-609a577f7880",
"db_language_id": "5fc419ec-f9e9-481b-95cd-d8b454b46550",
"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-05-15T04:14:57.2412109+00:00"
},
"modified_dateutc": "2026-05-15T04:14:57.2412109+00:00"
},
"marketing_segment_id": "8607d4ef-ebf7-489d-9fb0-306ed3cc9883",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3b9c49be-43b6-495f-af46-1b40c5133c20",
"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": "fac037d5-cb7a-43d6-acf5-bd7b7a9a25a1",
"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": "abc16c9a-56e2-4147-8416-6924a77c4349",
"db_country_code": "sample string 28",
"feelist_id": "76b9345e-0e73-4796-9c0b-d9a0dab7ec89",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b4dfbb9a-49a2-4ece-bc31-ea2c6ab2b57a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "204d7bda-8e9c-49d3-9061-b278cea426be",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-15T04:14:57.2568301+00:00",
"db_currency_id": "646f0b83-c349-41f1-b268-dcaeeede8849",
"db_currency_code": "sample string 10"
},
"company_type_id": "8af42cb3-1329-4d95-a84a-ba57b86b59c4",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a0c285b-ff4f-4b23-90ca-f36ff34bf290",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7cb71dcf-c6a7-48f0-bfab-4a754b32e4f9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d007460a-69e3-4594-9ae7-920b3f0b891b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f7421d5-d6ba-4386-92ec-ff11389cc235",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e51143ad-4c3e-4ccd-9a31-e0e7c4fc4899",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "46e4636c-e5fa-49c4-8dd6-7c5c9c806472",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-15T04:14:57.2568301+00:00"
},
"company_sector_id": "22af81eb-2086-4077-bdc9-a51873003355",
"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": "7ab1f466-e31b-4f4e-942f-eb0858af40f5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0814cf32-b704-4f4d-9c18-f9ac5bf06b75",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "39d714cb-6caf-477e-b867-aea5b0379b17",
"account_manager_user_code": "sample string 56",
"company_status_id": "c301a141-7b6a-45be-9145-4fb83c9a03a2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-15T04:14:57.2568301+00:00",
"id2": 60
},
"db_language_id": "7afa5b18-eead-4076-9577-7295bf3cc71c",
"db_language_code": "sample string 7",
"db_title_id": "245232f8-99cb-4650-9c66-26e90ae7602d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-15T04:14:57.2568301+00:00",
"create_date": "2026-05-15T04:14:57.2568301+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-05-15T04:14:57.2568301+00:00"
}