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": "440849f5-f140-4ea5-a42b-db0561c4a847",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "90326d55-26f7-4bac-b4a0-0f84719db988",
"company_code": "sample string 5",
"company": {
"id": "16bf9381-dac0-446c-a3cb-78ba75de4f05",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-10T05:45:28.4511011+00:00",
"sales_territory_id": "5147d892-b403-4b85-80ed-91ccbe52ea2d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1522cee1-cb97-434a-80af-875118514d47",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f806c024-e610-4ccc-a149-cfe6e332e273",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "15cfd5f4-da2e-455b-b8ce-73b4d6e69282",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8bbf52dd-7740-47d4-82b9-7fafb1535fb1",
"db_currency_id": "513b6e30-5711-4353-a859-2867a66c838d",
"db_language_id": "66f602be-6110-49a4-b670-3d312e6dbc8b",
"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-10T05:45:28.4511011+00:00"
},
"modified_dateutc": "2026-07-10T05:45:28.4511011+00:00"
},
"marketing_segment_id": "6435632b-1778-4494-9bb8-da92764e4046",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "915fcbe1-e22c-48bd-b648-95b1b190eb08",
"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": "7f154841-602a-4efd-a7c2-06cb87056aaa",
"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": "e8095d1a-e8ee-4425-8c55-1d2244a5e736",
"db_country_code": "sample string 28",
"feelist_id": "d0c50000-78e0-4322-9389-c7999300dd7f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "55791fb3-a8a5-4059-858d-b066032ed964",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6507d646-26a5-48e2-a416-4fe0010a1ad4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-10T05:45:28.4667255+00:00",
"db_currency_id": "7170c016-96cf-4279-9c77-78ffc7c159dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "276d007a-d89f-485b-9483-4321e7d0080e",
"company_type_name": "sample string 32",
"company_type": {
"id": "1936f6a5-0908-4283-b5a6-ff352d4a5418",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0958d26f-e5d7-4f9e-baac-4c172bea7630",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f70fefff-1cc5-428d-a9d0-ecedb525c8e3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e5c6ee7-336e-479a-8e9f-6162bfadb8ab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "46227d4a-6feb-4c85-a725-88b48647da42",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c2952222-e308-480c-b796-91a76ce65c81",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-10T05:45:28.4667255+00:00"
},
"company_sector_id": "5405e6df-96d7-432a-9149-15e5e1e7009f",
"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": "beb734d4-f2de-4699-9094-606afcab1065",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f5e3f910-9026-46d3-9a90-d01274b065ec",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "614cfa51-032a-4a39-a4f8-65b76a666895",
"account_manager_user_code": "sample string 56",
"company_status_id": "e19dc00c-97b8-4c86-9ba4-7069413804ef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-10T05:45:28.4667255+00:00",
"id2": 60
},
"db_language_id": "76d5e2c0-a218-4e8d-8984-8ab764d25312",
"db_language_code": "sample string 7",
"db_title_id": "36fb0f99-bba6-406e-a1a0-c265f263faa8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-10T05:45:28.4667255+00:00",
"create_date": "2026-07-10T05:45:28.4667255+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-10T05:45:28.4667255+00:00"
}