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": "20bddcf0-61f9-4931-bd4d-105bd5df5c8c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eed037b1-dd20-4789-9c73-260cf38fcd7f",
"company_code": "sample string 5",
"company": {
"id": "532dc7d6-de0a-49d3-828e-a1cd6d7e9d8d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-01T21:14:34.6089079+00:00",
"sales_territory_id": "e6b90585-f266-4f1f-bf27-82067335f88d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a181a1d0-0abe-45dd-b621-1972b19e5ecc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1216e51d-3014-43f8-bc0a-971d8de8bf62",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f6989a40-c4f6-4ae4-a795-563dc20683ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9215c66f-3a18-413e-bc07-a52b0d79355a",
"db_currency_id": "e234338e-b4db-419f-860e-a146e8c67b40",
"db_language_id": "bb525273-4977-4fb1-979b-bd4f14527ff1",
"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-08-01T21:14:34.6089079+00:00"
},
"modified_dateutc": "2026-08-01T21:14:34.6089079+00:00"
},
"marketing_segment_id": "8341758e-f36c-4d35-bbf8-b75004e61587",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8bdea7be-25fe-4d10-9898-d196977c761a",
"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": "a493407b-6a7b-43cf-a0ea-359cadd9872c",
"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": "83278828-aff6-455c-bddb-339dce29af8e",
"db_country_code": "sample string 28",
"feelist_id": "355e07d9-86e7-453b-a7c1-0b01d94bb776",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bf1d08f5-f934-4514-aa34-9d82aea5b522",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "33d64b37-ab46-434d-9503-1bb4a21acb1a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-01T21:14:34.6089079+00:00",
"db_currency_id": "4f12341d-ded7-4c2f-bbbd-6658078eeb69",
"db_currency_code": "sample string 10"
},
"company_type_id": "c8454ea1-cf33-47ad-b864-d0b915c606b3",
"company_type_name": "sample string 32",
"company_type": {
"id": "ac48e6b9-7c37-4d4e-a210-a8eb9ccd29c8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e463a2f-a400-414a-af38-8b36d252e356",
"sales_organization_code": "sample string 5"
},
"db_language_id": "985fee2d-bfae-4c1c-8a32-37ce7d717c9e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "10c9479a-9eef-44a1-a6c5-4aceb1ffcad7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e0fad158-09ad-4fcf-aa05-abb228f01013",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b9803a16-3368-4809-a909-67701277d688",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-01T21:14:34.6089079+00:00"
},
"company_sector_id": "b99a4c1b-a328-4f7b-bad4-83d3b052e43f",
"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": "bd7a3924-f2db-4f9f-bbd6-c8da053b7842",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "39649f59-03ed-4049-ba35-9189bd4e4e00",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "082fd83e-d7af-483c-be33-7ce5eff05e37",
"account_manager_user_code": "sample string 56",
"company_status_id": "6c32860e-7a22-4d99-b73e-a5692fb73416",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-01T21:14:34.6089079+00:00",
"id2": 60
},
"db_language_id": "1e6907a2-14e8-4e3b-93ea-e76ab37ec5d5",
"db_language_code": "sample string 7",
"db_title_id": "2522bc98-612c-43e3-bfeb-622e9ca488ab",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-01T21:14:34.6089079+00:00",
"create_date": "2026-08-01T21:14:34.6089079+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-08-01T21:14:34.6089079+00:00"
}