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": "f5be8511-669e-4dda-a067-64755fb35be6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "14659ffe-f792-419c-aa58-96afce2e4955",
"company_code": "sample string 5",
"company": {
"id": "c59a61a4-b37c-4afd-b123-326bc9cc5783",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T06:13:17.418223+00:00",
"sales_territory_id": "73851fc8-29e9-4eb3-8759-3243ae36b9f4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "966ff811-b3e3-4270-ac16-0e16cebdb739",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3085fc28-8d7c-4605-88b6-8534c5ad8e83",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f2716240-bd70-40ac-83be-b4cbe617a50d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4844990b-5de9-408f-8c50-0cecc5d3bc4e",
"db_currency_id": "afe3801f-017d-4f50-a19d-1d8a5e37df4e",
"db_language_id": "5856feaa-08d4-4a5d-80f3-f4de16b70a34",
"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-03-12T06:13:17.418223+00:00"
},
"modified_dateutc": "2026-03-12T06:13:17.418223+00:00"
},
"marketing_segment_id": "db2acaf8-223e-4272-b743-56b3af7b9c99",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "19762df1-c982-4061-9c1a-f605b68e9e77",
"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": "35a1e066-1df1-45a2-94ef-6e0142165585",
"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": "cc959d64-b082-4e91-9c05-bbdecf32e643",
"db_country_code": "sample string 28",
"feelist_id": "eab189d8-df1d-403a-9694-15b198715094",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6f892841-0f49-4775-9360-0673be183b08",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "da6b03ab-e0b7-46d9-aa09-6b23148c0e8a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T06:13:17.418223+00:00",
"db_currency_id": "7e64be32-0eac-44a5-aa2f-1bb86d3cf91a",
"db_currency_code": "sample string 10"
},
"company_type_id": "9d24fe55-8cac-4a55-ac4e-d91935c38c3d",
"company_type_name": "sample string 32",
"company_type": {
"id": "e112d606-6c8b-457f-b85b-e51c20aa0464",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c4ca78ba-44ee-4c24-823c-c16184b1effb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7ba20db7-05a7-442c-84f5-87ddacb0a910",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8cc87039-5952-4cfd-b057-e56a227aa43a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c57dcc3c-ece5-43e1-ad82-c6907d2684b4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "baba710d-9f17-4a81-914b-3a76bc0ef961",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T06:13:17.418223+00:00"
},
"company_sector_id": "cc5a259e-e95a-43f2-96b7-6447a9328221",
"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": "6447a75f-a2f1-4447-9ff4-aec02cb6cf79",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "160d83b1-3200-4551-92d5-95264c827516",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "90b4ac0f-00fd-40c0-b594-50d37de96d60",
"account_manager_user_code": "sample string 56",
"company_status_id": "a2339682-b758-482a-8582-261e6786fc53",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T06:13:17.418223+00:00",
"id2": 60
},
"db_language_id": "f0193141-2c32-4719-9642-62e366710cd5",
"db_language_code": "sample string 7",
"db_title_id": "e77b65ed-aedf-4d11-a331-4420de57141a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T06:13:17.418223+00:00",
"create_date": "2026-03-12T06:13:17.418223+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-03-12T06:13:17.418223+00:00"
}