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": "f6452582-6a12-4bd4-9c72-72a9d4ee61bd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4805e087-d1ab-43e2-bf25-fcd65b705317",
"company_code": "sample string 5",
"company": {
"id": "4e727859-57b3-4b12-aaef-b8de073f8f80",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-21T12:57:59.5689759+00:00",
"sales_territory_id": "296e756e-ebb4-49aa-bde0-a2d30692a1d3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d031b9a9-d96b-4f6b-bab4-279e028a732e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cb7ab1f5-7fcb-4980-93c6-d8c18fab7d77",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ce1d886-51db-4da5-bc4c-a579736f3df7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81099ab-f73e-4459-ac8c-52a8d32cd705",
"db_currency_id": "31de4beb-b0d8-4106-8e9f-45c078241c55",
"db_language_id": "a0c7fa16-c6a2-4aac-bea7-b2ed8a3e46e7",
"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-01-21T12:57:59.5689759+00:00"
},
"modified_dateutc": "2026-01-21T12:57:59.5689759+00:00"
},
"marketing_segment_id": "a085cd0a-d09b-494d-9ee3-1b7ce06848f2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "52d84975-0ab2-4d96-aa65-f51cc2644e8a",
"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": "4e020868-58ff-42d4-8fef-63f53e4fb3bb",
"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": "1fb51d89-cb58-418d-8b99-65c21e0488ce",
"db_country_code": "sample string 28",
"feelist_id": "51ba42fb-4e6b-4a7e-a956-46fea86d4de8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a9413eb5-e26d-4cd0-844a-8def48158f71",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b35468d5-6263-46f5-b034-08e1ff75ebec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-21T12:57:59.5689759+00:00",
"db_currency_id": "e6dbe2ae-e51b-4e24-8591-d27ea9e0662f",
"db_currency_code": "sample string 10"
},
"company_type_id": "cbb825b6-5013-42ad-9ea3-63d1f01e2481",
"company_type_name": "sample string 32",
"company_type": {
"id": "567a800c-e4cb-4899-9f07-016c27f213f2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dbd91788-3df4-449f-a70b-0278d21ab2e1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0e1f8ad3-d33b-4d8d-843e-ee9cc67db5ce",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7de13f07-0de8-457d-b3a9-0875ef663c9d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4676a2ee-ed87-4fa7-a8d2-58d5ed4c1ac3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2486d3bc-f8b3-4c7f-852d-109f13a17a9f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-21T12:57:59.5689759+00:00"
},
"company_sector_id": "88be45bc-6e83-4f12-96e9-b36fc7b7029d",
"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": "374eb9a4-6797-4924-92bd-684bdbe2798c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "302d8881-c4aa-4413-b611-c7757d2fe5fb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "83838d17-cc76-41b0-bd2e-1a4748501eba",
"account_manager_user_code": "sample string 56",
"company_status_id": "616db375-8aa5-4603-bed0-31472439b9ff",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-21T12:57:59.5689759+00:00",
"id2": 60
},
"db_language_id": "60811af5-0712-4558-a16f-7cc46d37c81d",
"db_language_code": "sample string 7",
"db_title_id": "af26a576-3c8e-49ec-992a-0a5ea0284024",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-21T12:57:59.5689759+00:00",
"create_date": "2026-01-21T12:57:59.5689759+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-01-21T12:57:59.5689759+00:00"
}