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": "8476ef27-c42e-4f57-9f0c-abe69537c12b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ee5dcace-184b-42c6-93a3-c6436a6de422",
"company_code": "sample string 5",
"company": {
"id": "2fe46251-4367-42d6-abb3-b64ca343543a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-10T23:14:23.2030891+00:00",
"sales_territory_id": "774e3257-d2de-40e6-90cf-0cd75a240881",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a6d9a43e-7112-49e5-9a75-138cd64b8e39",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3c1dd97c-ad02-451b-baf4-389e3f08a71d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a297f77b-5fac-488c-a621-5d46479ef9c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c276330-3254-4556-8cad-50e89cf78405",
"db_currency_id": "2764f272-14d8-4221-bc3e-72f7dc62605d",
"db_language_id": "4580d4ed-7bcd-4bc5-b7cf-01359dc12daf",
"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-06-10T23:14:23.2030891+00:00"
},
"modified_dateutc": "2026-06-10T23:14:23.2030891+00:00"
},
"marketing_segment_id": "74f06f88-6b2e-4a29-a9f4-7a95779c92cb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a893bc9e-3b22-46e9-bd9b-8149f98a2ecd",
"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": "96f12b6d-8914-4dd6-b40c-4c445c57bf94",
"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": "989a8ad3-8ca5-41f7-a58c-5738182fb566",
"db_country_code": "sample string 28",
"feelist_id": "8b171fe4-980a-40d9-a8ec-6c06ce163fc2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "40ac6738-8fec-4a91-a0d7-a39684f86a71",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c1bd923d-28b9-4a77-91f1-6d6b3b083b87",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-10T23:14:23.2030891+00:00",
"db_currency_id": "a066fa7a-6b31-4b19-b5d8-54f3c4561540",
"db_currency_code": "sample string 10"
},
"company_type_id": "8538a6cd-dc6c-412f-84a8-31be89a5a38f",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae145ca5-18f1-4146-8354-c003fab0003f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0123aa1e-8fcf-44bf-9fc1-7b0d16864b03",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7de0f9d1-a911-42e0-9065-f3882a20432b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d9bc7e6e-1de4-4ce0-8b74-c4fff7188952",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cc7b1b34-2e01-4367-880f-1ea41e8bfb13",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fee41166-95fb-4afa-8cb4-4e1e2071bd1b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-10T23:14:23.2030891+00:00"
},
"company_sector_id": "3d17d1c6-62e8-4d9a-b140-261640f78bfc",
"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": "7e92feb6-32f0-4e02-bcf6-fb7077e458e8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "10c86632-65df-452b-b5fb-aa5e0a12877f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "39489aae-7b3f-45ab-8729-0a268b5b7953",
"account_manager_user_code": "sample string 56",
"company_status_id": "b644a8aa-823c-4a97-bf7a-5f1fdd2eac56",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-10T23:14:23.2030891+00:00",
"id2": 60
},
"db_language_id": "44b89434-e775-43fb-b5fa-51c64bc80c3a",
"db_language_code": "sample string 7",
"db_title_id": "e8b0a580-c861-4881-9d52-d97b56d5fb4a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-10T23:14:23.2030891+00:00",
"create_date": "2026-06-10T23:14:23.2030891+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-06-10T23:14:23.2030891+00:00"
}