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": "328367d3-9cd1-47b0-aa54-6fde21069666",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d7b0ed3d-5dd4-4019-9070-66cd6b3cc3a3",
"company_code": "sample string 5",
"company": {
"id": "cb11b0bc-af39-4b2f-93fc-eb2a1766c20d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-09T07:40:56.7920839+00:00",
"sales_territory_id": "45082fb8-6ebf-4939-8fd1-d04ea3831c8a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e1f3cf25-75ea-4b89-9eb6-d01f91ca99c1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "da3e122e-479a-433c-9d18-e8c60d1f905b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fdde7cd6-a1f0-4020-a717-39c213771c19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d65c5602-4866-42a7-ab86-ecdcaf6ba3e9",
"db_currency_id": "3f9a2974-f18e-4ac6-ac8d-913c9f4c0f2e",
"db_language_id": "4ecd9443-e0c6-4a9d-acd3-b913d257dc03",
"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-06-09T07:40:56.7920839+00:00"
},
"modified_dateutc": "2026-06-09T07:40:56.7920839+00:00"
},
"marketing_segment_id": "51f50a98-7dfb-4b50-8601-b311d7329c98",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bac990f5-df43-4454-b274-3ac383a4c994",
"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": "3890fa2c-d85b-419d-855b-68639109ff2b",
"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": "c46efdf5-1998-434e-8828-b629045109da",
"db_country_code": "sample string 28",
"feelist_id": "fb9c90aa-1622-489c-81ec-02249a16a240",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4656c6be-5aed-478f-9b3a-c5a35dc21b7a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "709777db-162a-4336-92c5-db8345f24ff9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-09T07:40:56.7920839+00:00",
"db_currency_id": "e8f511b0-0b97-4e9e-9674-00bff0a77797",
"db_currency_code": "sample string 10"
},
"company_type_id": "5058505c-7b45-4d3a-8b92-26ee2a222407",
"company_type_name": "sample string 32",
"company_type": {
"id": "97941eea-597a-490b-b7bb-f800df5cd496",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58d13637-c1f2-43ae-ad51-b2e187ae4052",
"sales_organization_code": "sample string 5"
},
"db_language_id": "afe48451-1b0e-431c-8a7d-95b2ae3dd49f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "99bb401d-b065-40a4-94f8-81dbfdfbbf6c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "81a7e935-91c6-4e50-808e-f088e8ec609d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d895545b-231f-4b35-890f-82bcc8bd1879",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-09T07:40:56.7920839+00:00"
},
"company_sector_id": "53bc28b9-b542-4e66-ac4a-6ba1318cf738",
"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": "3286edf7-6934-4545-b88d-babf0f5b78bf",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ea9b37b6-600f-4591-a520-40ba3a99e03d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c0c9030b-778a-4d1a-9505-eedf8d0b166f",
"account_manager_user_code": "sample string 56",
"company_status_id": "de825639-458d-4320-9fc3-b6d51c69cd4a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-09T07:40:56.7920839+00:00",
"id2": 60
},
"db_language_id": "f91df1ac-51f5-43c8-94e4-b714a7a2d9f8",
"db_language_code": "sample string 7",
"db_title_id": "99ef4cf1-e83d-49e7-96bb-1eaf2f2f8880",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-09T07:40:56.7920839+00:00",
"create_date": "2026-06-09T07:40:56.7920839+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-06-09T07:40:56.7920839+00:00"
}