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": "5cc2564c-ec0d-4baa-adb9-647ad6ba2ad3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4d4be3fc-68c0-4839-a096-4b128ad82db1",
"company_code": "sample string 5",
"company": {
"id": "bc547e84-1f90-4f1c-846b-266b3cab9063",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-17T18:31:36.4318496+00:00",
"sales_territory_id": "9007edfd-ad77-4f58-a442-6778bb3ec97f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4eb6949a-db21-4533-915d-15179a64d35e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3ea6f1bd-0a18-43bd-bfc8-313cdb9a02d1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "68f3ef5a-42cc-45c4-aca4-ef973ef6c541",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1975f679-c444-4ebc-bf1f-9193220ecb89",
"db_currency_id": "8bb4cea8-4fa8-41e8-8ba2-74983d2cc956",
"db_language_id": "0a975a7d-feec-49b6-b288-1090e62ab90d",
"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-07-17T18:31:36.4318496+00:00"
},
"modified_dateutc": "2026-07-17T18:31:36.4318496+00:00"
},
"marketing_segment_id": "8c4eab11-c55a-49b4-be60-c30bbc171d35",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "98f7ffce-9dc2-4f53-8a3f-c515650d7a6b",
"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": "49b1099b-c2b3-401e-b7d6-7b67fb187d6c",
"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": "156ea836-d58b-461a-8cd9-9143a4e0ad14",
"db_country_code": "sample string 28",
"feelist_id": "8077d8d4-be32-4f8e-93ec-bfff3ce2f4b6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "09325849-17fc-4f54-9140-55ec185fabe8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9afb4005-a9ad-4f00-b611-cce75913c6b1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-17T18:31:36.4318496+00:00",
"db_currency_id": "b0683f16-03f8-4f80-8e1f-e570ccd688a2",
"db_currency_code": "sample string 10"
},
"company_type_id": "a8c7c98b-1631-4472-a085-4e5493e7a583",
"company_type_name": "sample string 32",
"company_type": {
"id": "422fcd24-ef18-4841-9b39-29c467d8196f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ecb92341-fe1f-4b92-8fcd-c20e1568fe67",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1ecde893-0ac7-4dc9-97bd-294dbcdec3b2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9603a8ec-d1f6-4860-910d-6196e05a537f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1751217d-af7e-49c7-afe3-88f56436f8fb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4f2e4004-0d94-48b4-bea9-1ff7a577edb2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-17T18:31:36.4318496+00:00"
},
"company_sector_id": "92f43606-ce5d-4f55-b8b3-e6785e1d8d75",
"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": "e11e8465-a93a-43d7-a870-520523bc6041",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b3c8820d-30d6-4834-aec1-7b3147472edb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4d750be1-a9c4-481a-b7b8-9fc176f6e6f9",
"account_manager_user_code": "sample string 56",
"company_status_id": "599d135b-ad8b-4c02-b671-1060cf2100ed",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-17T18:31:36.4318496+00:00",
"id2": 60
},
"db_language_id": "b5fec256-9d28-4516-a453-f349124bbe0c",
"db_language_code": "sample string 7",
"db_title_id": "b4d689c1-acb9-43f2-b09e-008d6efc6443",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-17T18:31:36.4318496+00:00",
"create_date": "2026-07-17T18:31:36.4318496+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-07-17T18:31:36.4318496+00:00"
}