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": "dc071e49-01bd-4450-8190-b771ac5551be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "28b3c2ec-8bc2-44f4-adcd-a7e6ef48702c",
"company_code": "sample string 5",
"company": {
"id": "446652cb-8bde-4a7f-9d53-2ae6322286f1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-14T08:18:37.6744555+00:00",
"sales_territory_id": "3223738b-2bdb-4d6b-a384-991636fbb5b8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd34796e-6b32-41fa-a2b0-0b7cb131fbb3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88103432-e22f-4a7e-9566-1e1d6884e0c5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6203b19e-a652-434b-8d68-01246926422f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6318fcc3-ffe5-4524-afd5-9cb17567dedf",
"db_currency_id": "d3c833b3-87d1-4869-aaf5-3f4d009d97cb",
"db_language_id": "e09b4537-6469-4e22-b224-340e3d605a49",
"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-01-14T08:18:37.6744555+00:00"
},
"modified_dateutc": "2026-01-14T08:18:37.6744555+00:00"
},
"marketing_segment_id": "2a084e84-5baa-4dff-ba50-ae8e31606994",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3f2f723e-fe18-4cc4-a58e-f8252e7ba60a",
"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": "57af22d1-4233-4b55-8904-ec4dd00ddaac",
"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": "38e0a2e2-414e-4b59-8da4-fdfb633020bd",
"db_country_code": "sample string 28",
"feelist_id": "e4f8aab7-8fbc-4de8-9f89-bddcf251aaee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cbbbbb52-3d50-4e60-83ef-1e8d6b7a3377",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "089560c9-71f1-4970-96ca-2ba3b0db5f08",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-14T08:18:37.6744555+00:00",
"db_currency_id": "19561b80-d207-4aca-affc-11049c8a66d5",
"db_currency_code": "sample string 10"
},
"company_type_id": "27acf184-f34c-4627-9710-67225fec39bb",
"company_type_name": "sample string 32",
"company_type": {
"id": "20b7d7e8-c4c2-4e8e-a4cb-22b3f2ecd6c9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ec645d6d-6dae-4772-a3ba-43b46c295624",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bc011118-e2ef-49f5-bbda-e5db686aada9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "96138298-8168-4b50-b3aa-f446e0fa53da",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3b231def-3a97-4a8a-a0d0-1b01365de207",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a430f9f1-d971-49e2-a4eb-ea2fd4791c0a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-14T08:18:37.6744555+00:00"
},
"company_sector_id": "20276bd6-6629-41b4-b74e-781322ab1588",
"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": "cea536f6-43c9-47a0-8f2b-5d24443942fc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "989ddbae-f2dd-4db6-96a9-218e8bb9d3d4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b4e41076-9416-43bd-b2ea-b4842531dd6d",
"account_manager_user_code": "sample string 56",
"company_status_id": "a28e1cb6-5804-4a1d-818e-58ab910c7615",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-14T08:18:37.6900802+00:00",
"id2": 60
},
"db_language_id": "680ff577-7737-4844-bd65-1ef4c8458e83",
"db_language_code": "sample string 7",
"db_title_id": "4fc14ff3-a4fa-46fa-b4e7-7ef45a3340fa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-14T08:18:37.6900802+00:00",
"create_date": "2026-01-14T08:18:37.6900802+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-01-14T08:18:37.6900802+00:00"
}