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": "9c2ff7d3-b288-41ad-8102-d70d86db0cc9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e1deb96d-c0de-4607-911f-975223743ac9",
"company_code": "sample string 5",
"company": {
"id": "11a75e9d-2127-4ada-847a-1f354c46a61e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-26T19:01:57.140114+00:00",
"sales_territory_id": "c37eb9fd-bb64-4c67-ba37-5df46f00ef05",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0b764289-0263-433d-ac09-00b907512dad",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "933cc2b0-0047-4310-962d-04e2b0ecc427",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d09ec8b-a649-478a-8206-abf320f07020",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaff6b30-393b-4a27-bd73-bf784a9c0a00",
"db_currency_id": "4bd3a9a4-1ddc-418c-8517-c778c4089fe5",
"db_language_id": "93fd8dce-55ad-4bbd-9e57-83e5271f0db8",
"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-26T19:01:57.140114+00:00"
},
"modified_dateutc": "2026-07-26T19:01:57.140114+00:00"
},
"marketing_segment_id": "a6d2d1d9-3e53-4093-b712-1d239f505ade",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3bc7dc3a-ec34-440a-8279-e5adf0c98b8f",
"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": "2991235b-0761-4fe2-ab86-2d390956228c",
"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": "2299ecad-86e1-4c6d-b5a7-ad203f83d7d9",
"db_country_code": "sample string 28",
"feelist_id": "ac837a56-3b12-45de-afc1-b8ab435f8de6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "079e50ff-b510-477e-a155-eab05bb1e627",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2e903144-b46f-43de-a3e2-d5300ba8c789",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-26T19:01:57.140114+00:00",
"db_currency_id": "a3eb7f57-7a22-4084-b9f1-d51a3dc03df3",
"db_currency_code": "sample string 10"
},
"company_type_id": "b49302f5-f2de-41af-9307-f0082235b8f5",
"company_type_name": "sample string 32",
"company_type": {
"id": "b7611b78-dd14-4797-9a6c-81bf477bc023",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fc6f61f5-ebe2-4f18-9316-ae9ae56f71c5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0005a12b-9838-4ebc-aef9-a8304545d2b1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "da8a64aa-6653-48ec-aaa1-36950cee4a57",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6c841225-cea0-4f6a-9e08-27dbd18b82bc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dcb27338-176a-44a9-a220-40e93e9dbf25",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-26T19:01:57.140114+00:00"
},
"company_sector_id": "e9d11aa6-736d-4041-b4bc-6859991ccb4a",
"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": "73115fc9-58c5-4a74-97c7-5b4aff4171e2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8db73de0-5cb8-404c-9077-273b8bd81000",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "61f9062f-08be-4c35-b4f4-27f2da71a35a",
"account_manager_user_code": "sample string 56",
"company_status_id": "487cf996-e4db-4c74-9b6f-e9152e0f7d26",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-26T19:01:57.140114+00:00",
"id2": 60
},
"db_language_id": "de0d1e76-084c-4b9c-904c-0f9af3b46e9b",
"db_language_code": "sample string 7",
"db_title_id": "b6d86870-243c-4f9f-a445-54ce89ddfaac",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-26T19:01:57.140114+00:00",
"create_date": "2026-07-26T19:01:57.140114+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-26T19:01:57.140114+00:00"
}