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": "469b2eac-07b3-4fb4-a66c-243cd0891d3c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d2fe7442-725b-4349-bf4f-bcaedad4b5e4",
"company_code": "sample string 5",
"company": {
"id": "2492222e-091a-48d5-9aaf-da9125f2f92c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-27T18:48:34.8651399+00:00",
"sales_territory_id": "64b26064-a1c5-4577-ba54-193a368b7fe6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cfb37d64-632b-4e33-b13f-ef9ddd022fdc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "be86ab73-7e34-41f0-a900-7421b454078f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8eb0dd33-695b-4c23-a38e-5eb1fdaf2e28",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a277b173-f24f-4355-bb2e-c3ac9ddf45a0",
"db_currency_id": "ac06e529-e332-456f-b7aa-73059ec24d8d",
"db_language_id": "817df197-b599-4129-a9ba-b8fca38ee744",
"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-02-27T18:48:34.8651399+00:00"
},
"modified_dateutc": "2026-02-27T18:48:34.8651399+00:00"
},
"marketing_segment_id": "66f0c3af-bc88-4cc6-8f1d-91c0ef4f1093",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "79977cbe-043e-4fdf-a4bf-a20fdcd6b971",
"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": "b278e2a5-d2ff-4abf-88a0-8dee8b91dfe4",
"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": "9b47d6a2-c742-440b-b15e-190e41d72562",
"db_country_code": "sample string 28",
"feelist_id": "b3374d25-0bcf-45df-801b-d6f70f33df37",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "23577b89-1ded-4f24-a7c7-9ccadb6512bc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "196f6811-446a-4743-aa31-672cf5ee47d4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-27T18:48:34.8651399+00:00",
"db_currency_id": "578ed3b1-8731-47b7-8b14-ef6ae97abf14",
"db_currency_code": "sample string 10"
},
"company_type_id": "9863086c-ca06-4185-b9e4-d128b0aff04a",
"company_type_name": "sample string 32",
"company_type": {
"id": "40352872-1c0b-42d8-a3c9-d2ca34583103",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30f1d65a-d932-49e2-a90a-a0240c609821",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aa3ed1a1-6ad0-4343-912c-1f174437c21e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "53d2072f-a5f8-4db6-be35-45968952699e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cc1f1ecc-e2ad-4d4d-98bc-bbd665de49c4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "95ea844a-1339-4f68-a3a4-785a4ba8a4ec",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-27T18:48:34.8651399+00:00"
},
"company_sector_id": "576280d0-25c1-49a1-98b8-2418eda4def0",
"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": "d866a35f-466e-4a2c-b653-e416b00bda45",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "122cbb43-a5d4-4963-aad1-2f446128fa93",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5e47d661-e50b-4549-a16c-e3608c5e192d",
"account_manager_user_code": "sample string 56",
"company_status_id": "94506450-5d99-4043-98ab-06be9134ee35",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-27T18:48:34.8651399+00:00",
"id2": 60
},
"db_language_id": "973d6a05-6366-4c97-a682-b63a9423fadd",
"db_language_code": "sample string 7",
"db_title_id": "f210bf1f-beda-4a7a-af6a-c0fec26b9ebd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-27T18:48:34.8651399+00:00",
"create_date": "2026-02-27T18:48:34.8651399+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-02-27T18:48:34.8651399+00:00"
}