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": "ca021a3e-8287-42cd-a796-6d70f0fcf31f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "114f6a72-686c-4881-92b3-38f21f428b2c",
"company_code": "sample string 5",
"company": {
"id": "d202322a-932f-4c27-a860-1939e8a6d8c5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-23T08:56:29.5648728+00:00",
"sales_territory_id": "11971128-79ce-4b73-8e7f-8ea7cf09a9c9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b5afd5d6-34bb-4fa4-ad59-66555f3d951e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5e374fc-6264-4cdd-8edb-2a2aff26677b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65b7a30a-a52a-400d-9a65-a372b7c33392",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be34372b-050c-4631-82f8-6de1bca1103e",
"db_currency_id": "b3834835-1f60-41ed-a21d-9de65e9d3e9e",
"db_language_id": "7ba1ca65-61c9-482c-9600-84115ebdb828",
"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-23T08:56:29.5648728+00:00"
},
"modified_dateutc": "2026-01-23T08:56:29.5648728+00:00"
},
"marketing_segment_id": "e6721b94-9433-4ba7-8da9-a65e135a224d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cad7c6e0-ad61-4924-b078-cb11058b8879",
"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": "fafcfa15-888d-472f-88a3-c3952a655e7d",
"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": "1b6fb7f4-1f67-4445-8bf6-c2a0ad86d3b8",
"db_country_code": "sample string 28",
"feelist_id": "0ab47505-4ec8-4625-8d3e-9fd2ed444f15",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f18062fd-8b5b-43d3-93d5-9fceb074dd58",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f2610250-1a75-420e-a706-ae5f6aa3e4ec",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-23T08:56:29.5648728+00:00",
"db_currency_id": "2d4548db-ce4d-4bbd-9184-9855b12b99b2",
"db_currency_code": "sample string 10"
},
"company_type_id": "6d8b9272-eabd-4d63-9212-1498fe1f8d0b",
"company_type_name": "sample string 32",
"company_type": {
"id": "9cffb635-d273-48f4-8bb0-58b902d45ad3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e34b504-074d-4470-ad22-54082e615690",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ead15cdb-81b8-4e67-9cf7-d17b0ea7407d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ab9b9438-4e85-4008-b2d4-93e260a64b64",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "392138e8-299f-4aa8-9300-cea0bde5a6fe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "769202c5-3287-402b-93fa-c1335a489568",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-23T08:56:29.5648728+00:00"
},
"company_sector_id": "df1effce-8cb1-434a-beef-ee2503593d1c",
"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": "82a09dcd-a95b-4580-8773-20b37e8c2512",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3ac827ed-35c4-47eb-ac24-8c2f059c1291",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "32a631c5-1687-4bcf-830f-63f9cfce5b79",
"account_manager_user_code": "sample string 56",
"company_status_id": "ddb6f614-9203-40e5-8c3d-b191566bb54c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-23T08:56:29.5648728+00:00",
"id2": 60
},
"db_language_id": "49996fa6-e5c9-4419-9376-200ad1dc421e",
"db_language_code": "sample string 7",
"db_title_id": "dfb59992-321b-40fb-8776-a54a97f9c26c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-23T08:56:29.5648728+00:00",
"create_date": "2026-01-23T08:56:29.5648728+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-23T08:56:29.5648728+00:00"
}