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": "e0e671e5-862d-4369-9fd3-185ddfd6e065",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "13a72c53-efe7-4805-ae82-2e63a7a80497",
"company_code": "sample string 5",
"company": {
"id": "8c36282a-c772-47c2-9c72-16e00137a391",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-19T19:50:33.3508597+00:00",
"sales_territory_id": "51bcea83-4d59-419b-a460-bf58e02033e1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "982c8bbf-e0c8-473c-b10b-c5d731651ee3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "297587e1-5405-4861-a121-14d45e942eaf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aba084b9-1e8a-4e3a-a8cb-09c3b9cf68d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dbc1a32e-6e22-4037-84c1-73e092ebcb48",
"db_currency_id": "4b30c25a-494e-4d8d-b450-672a48a01e39",
"db_language_id": "7519af28-1d30-420f-9919-0794948ac601",
"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-05-19T19:50:33.3508597+00:00"
},
"modified_dateutc": "2026-05-19T19:50:33.3508597+00:00"
},
"marketing_segment_id": "0b615c6f-57ac-4612-b453-e05c774c742c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0ebec580-7403-48a7-b29c-d4e4e9d3be66",
"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": "1d8638e0-bbb1-4d22-81c7-2ee5bc5365a1",
"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": "512368f1-10c2-4b3d-9335-320e80684404",
"db_country_code": "sample string 28",
"feelist_id": "9a9f644b-93d5-4901-9061-33021d37ae74",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6df30541-fa8f-4509-823e-905d30688052",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "deaba2e9-9cf6-4003-bdc9-97df97cfa5d6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-19T19:50:33.3508597+00:00",
"db_currency_id": "e932d029-2f0a-4224-946b-aa23840197fc",
"db_currency_code": "sample string 10"
},
"company_type_id": "75e084c3-66a7-4d82-95c2-cfc339732978",
"company_type_name": "sample string 32",
"company_type": {
"id": "afd6ed31-6a87-4358-a899-e9c77c59258a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "07b0e40b-75c6-4904-bf37-143a444dc624",
"sales_organization_code": "sample string 5"
},
"db_language_id": "792d1da6-dcad-45b3-8cf7-705f2751b042",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fd03f371-fa2e-4c6d-a302-4427bf07e57e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3d1ea204-cb3a-409b-87c6-e4fb3ef3a9ba",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "233c0c2e-40e2-4ad1-84a6-7ad54765edff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-19T19:50:33.3508597+00:00"
},
"company_sector_id": "71c67f57-0e30-452c-84b5-a5256dc988bc",
"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": "65e8cc43-fb15-4c7c-bfe3-ef19af3f8739",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb16b47f-d097-45db-a12e-4c19b6cc6c7d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3d6b1eb0-873f-41ad-a279-2384d9867eda",
"account_manager_user_code": "sample string 56",
"company_status_id": "6702592b-ed17-4cc0-be0f-165e776e2323",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-19T19:50:33.3508597+00:00",
"id2": 60
},
"db_language_id": "2b2a5bc6-5baa-43ee-99f7-881508ca01cc",
"db_language_code": "sample string 7",
"db_title_id": "0cdca49f-483d-46d2-b729-a92f1ea63ef4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-19T19:50:33.3508597+00:00",
"create_date": "2026-05-19T19:50:33.3508597+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-05-19T19:50:33.3508597+00:00"
}