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": "426e3701-60b2-4dbd-8858-eb17ed05cc5c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "48a63e18-469b-4c9c-9380-606ad13d36b3",
"company_code": "sample string 5",
"company": {
"id": "69b14c52-aaa6-4356-b84e-9138fc9bf7f1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-27T23:26:04.3517367+00:00",
"sales_territory_id": "b2b07c6e-50aa-483e-a155-e264e4b0ddc9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7a77dd6b-8132-4833-ad34-2e2222c08023",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "499a3aa9-46cd-416f-88d7-30a4ddac7d65",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70d0ff08-17ee-4b45-98a3-4a4b7480dcf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b7166b3f-d1d6-416f-ab15-8e073f99b76c",
"db_currency_id": "b42892a2-e578-4512-b559-f45ac410e2d9",
"db_language_id": "f3e7cc5b-404f-4702-8357-991163bfd714",
"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-08-27T23:26:04.3517367+00:00"
},
"modified_dateutc": "2026-08-27T23:26:04.3517367+00:00"
},
"marketing_segment_id": "0388a16b-49d4-4fca-9b9c-d82ef033d5c0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1c04696a-0ba4-4dc6-88ce-8f4deea07923",
"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": "7a03b86b-6519-4e2c-8554-c72b1159f34c",
"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": "b6cfaf1f-0f0e-46b4-940d-8dc600446486",
"db_country_code": "sample string 28",
"feelist_id": "440882b1-007c-4d71-b2c2-3e45d666f719",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f54bbbf2-e009-43b1-918c-a2f97b3ae45c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f99abca3-d5d7-4a15-84a3-d351e6b5b119",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-27T23:26:04.3517367+00:00",
"db_currency_id": "5638e5e6-ba95-4dce-a868-3d53bca12941",
"db_currency_code": "sample string 10"
},
"company_type_id": "fdd6d6a6-d792-44b1-b2ce-fc6ce473b0a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "be5e7295-077f-4467-b637-5fb743f993b7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e7909e4-b715-443d-8b7f-9dc4059ef75b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b3b80f61-a0b8-43c6-a029-3a768b631074",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d803aebd-af07-4909-87bb-2f4273dfb1ca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b38c3b8c-1eb8-4e17-8d2c-b3d84eaa4774",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5ddd18f6-4eae-4258-b215-16c68428211b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-27T23:26:04.3517367+00:00"
},
"company_sector_id": "87117e05-bd18-4843-9f97-c003c93cb25a",
"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": "863a61ec-625a-4c39-a450-17d2ce6eda81",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4fd16838-d74d-4668-80d5-303d0ba4d738",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "36aed637-2602-45f1-92f0-41e6797e2f8a",
"account_manager_user_code": "sample string 56",
"company_status_id": "5214197d-c41c-4d0e-adbf-812d094bc4ca",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-27T23:26:04.3517367+00:00",
"id2": 60
},
"db_language_id": "4996f458-e937-4c74-a249-89396074f3a5",
"db_language_code": "sample string 7",
"db_title_id": "82831629-a09b-4a74-80de-bfabcf65926d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-27T23:26:04.3517367+00:00",
"create_date": "2026-08-27T23:26:04.3517367+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-08-27T23:26:04.3517367+00:00"
}