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": "6fbf6e44-1884-4108-8d67-a8f36a723e12",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7cdd19c0-bbe3-416b-aa56-7a20c21562fc",
"company_code": "sample string 5",
"company": {
"id": "11cbd13c-9f14-4019-94d6-e44a78bab7c1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-29T09:59:04.3942028+00:00",
"sales_territory_id": "0b1a4b38-04ae-464e-98f2-e2cdd3dd27c8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "751d302a-ad0b-4725-b8b0-2f81854c724f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "82eb38d5-94be-42d8-ae55-72faa4e00fe4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "04091c8e-ebef-4f0c-8c3d-c46fab0de2e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d26d101-bc57-4655-b89d-db4827b1002d",
"db_currency_id": "57d1fd4d-97f2-45a5-9e3a-99e8d7b69890",
"db_language_id": "6a764eb2-4b04-48de-a9da-0878f076756d",
"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": "2025-11-29T09:59:04.3942028+00:00"
},
"modified_dateutc": "2025-11-29T09:59:04.3942028+00:00"
},
"marketing_segment_id": "d1f9e4d2-d256-4fd3-b10a-dd3789fd0e45",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f56788b3-6344-43e2-8412-49d739af61ca",
"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": "85facaf7-5c94-4988-bb7b-44863dfd1b4d",
"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": "8d68ced0-02c3-425a-9591-314f5272fef5",
"db_country_code": "sample string 28",
"feelist_id": "2fb7237b-280b-4c0a-9e10-b1a4e3c1b935",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5c2a7296-57b1-4237-821e-47c14c103c38",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ed22146f-bc27-4ffb-b25b-a855ac068933",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-29T09:59:04.3942028+00:00",
"db_currency_id": "03622f6f-7020-4a7d-8eff-3df04e334728",
"db_currency_code": "sample string 10"
},
"company_type_id": "c543b326-d39d-4903-a920-2af157547e86",
"company_type_name": "sample string 32",
"company_type": {
"id": "019a2278-d841-4f99-917f-484146c1105b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7aac53d0-ff99-4b21-84a5-afd40e35f7a2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2fa925ca-10ff-4328-81ca-8812df88a902",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4cabb8ae-80da-4e9c-b9fd-2e948a300c03",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a802da7d-d0c9-4ee4-93b2-40627d699f8a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e78bcffa-93bb-4db5-88fe-17d15d2f9417",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-29T09:59:04.3942028+00:00"
},
"company_sector_id": "f3b2d204-8a37-4fdf-8e9e-d92638516d69",
"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": "8bb4d370-6700-4788-b561-c52e7eb449c7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f4f8a3d7-e522-4e8b-bce6-4a746e1c2755",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "efd4fd48-bd13-41c2-8439-39d9c9e6357e",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b187313-d6e1-4d3f-8b0d-9f0e2fdc5743",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-29T09:59:04.3942028+00:00",
"id2": 60
},
"db_language_id": "11bcdff8-42d0-42b3-8a10-16f7f71db8c3",
"db_language_code": "sample string 7",
"db_title_id": "3e307ef4-ebf3-4761-affe-8f3b2948a24e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-29T09:59:04.3942028+00:00",
"create_date": "2025-11-29T09:59:04.3942028+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": "2025-11-29T09:59:04.3942028+00:00"
}