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": "5933468d-5181-46c5-ad2c-f1ad9f46b6b0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2b88991b-c6bf-45a8-a5f6-b2465d97171b",
"company_code": "sample string 5",
"company": {
"id": "663a2270-3224-4186-8751-2a77171baf96",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-06T15:19:40.3907172+00:00",
"sales_territory_id": "3d98da8f-5734-44cd-9e42-abe21de12130",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4dccfd15-5677-4256-a73a-359af8719b17",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a8a706f5-9d7b-4a0b-8bb9-66796bc1dd75",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "35193af9-6707-480c-afea-e2cf75641b6a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a705708d-ee9a-47fa-ba54-26874d1fb2c8",
"db_currency_id": "5a4ad8f3-61c5-4fa2-9ec5-790cbe044dc2",
"db_language_id": "75f2f4c0-8c3a-4074-bb0d-f72cde467505",
"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-10-06T15:19:40.3907172+00:00"
},
"modified_dateutc": "2026-10-06T15:19:40.3907172+00:00"
},
"marketing_segment_id": "dabbc66c-55ce-4135-a816-f7137d0cedba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "733f21f3-b4f4-447e-bac5-ecae74f931eb",
"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": "45eca84f-297c-4f1b-953f-7b1d0b5267c3",
"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": "c8d96dd8-9ce1-4368-822e-95de97d32193",
"db_country_code": "sample string 28",
"feelist_id": "b2031c50-59e6-4df3-86c1-42a9385609b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5ea07949-aad9-4e07-b4a1-1c91f220b063",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e0d60e58-5c5d-4afa-9ef5-5137a05b829e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-06T15:19:40.3907172+00:00",
"db_currency_id": "318453c9-6b70-4d31-9b20-768323d90801",
"db_currency_code": "sample string 10"
},
"company_type_id": "87e909b8-af75-4f29-9e86-5bbbc224d0cb",
"company_type_name": "sample string 32",
"company_type": {
"id": "159b2cdd-2c2f-4b02-ad05-af83e5123fc5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b519eaba-5023-465b-80cd-a01278289a96",
"sales_organization_code": "sample string 5"
},
"db_language_id": "107b3079-b0c7-4f7a-8c69-b204724f089d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cc70d22a-83cb-4977-8c26-875701678ac5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c48a67b5-073f-4a41-b634-164b412280c2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c4a2d4a8-42b7-40c0-b5f1-56c384ae277b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-06T15:19:40.3907172+00:00"
},
"company_sector_id": "6576eabd-8e07-4c2d-8cc8-87dc335783c4",
"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": "e7692a24-eee4-4e32-b0ec-510c6e8b849e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e6878e7f-2d7c-4456-9703-ed9f818cbea4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2cc63b9e-f3f6-4726-a93c-989e370861d6",
"account_manager_user_code": "sample string 56",
"company_status_id": "7f9b2c2d-b1d5-4593-9bcd-83fbc3740e64",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-06T15:19:40.3907172+00:00",
"id2": 60
},
"db_language_id": "4f7b44d3-50f1-4ee1-888a-02b4b6a222fc",
"db_language_code": "sample string 7",
"db_title_id": "1b5491da-2653-4370-b0f4-45d9407cb126",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-06T15:19:40.3907172+00:00",
"create_date": "2026-10-06T15:19:40.3907172+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-10-06T15:19:40.3907172+00:00"
}