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": "70e7fa93-a841-4207-9a8b-cced9463bdfc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "50336eed-f2e1-4018-90fc-6eaaa33e1b67",
"company_code": "sample string 5",
"company": {
"id": "581de31a-36c6-45f5-a0eb-bcf660717f49",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-30T06:50:31.6004265+00:00",
"sales_territory_id": "40251fbb-e38d-44ad-9bd1-cfca4767e861",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8252a9dd-dc2a-473d-8959-bf28ee3ef20f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68262c45-8e94-4a31-8c00-eab209fa1fdc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47a4b6c2-8402-47ce-b762-a125c8fa3a0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0394081-3cd5-4c43-8949-4e4ffc44f2f6",
"db_currency_id": "97e5bffa-7acb-4a47-bffc-55b3bb70bb67",
"db_language_id": "aed2fd76-dc55-4b7c-90ab-b83ed1456cf6",
"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-08-30T06:50:31.6004265+00:00"
},
"modified_dateutc": "2026-08-30T06:50:31.6004265+00:00"
},
"marketing_segment_id": "3117b07a-e83d-43bc-8b22-c0c37ac54c5a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c2e44fc5-d7f3-49a7-b0f2-e4b3014ada4b",
"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": "70aa8842-a4e2-42b5-94f4-e0535ea4e90a",
"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": "416f4055-0cd5-4bdd-aa38-5715a38736f0",
"db_country_code": "sample string 28",
"feelist_id": "03283944-542f-4bdb-a3fa-6f4bd76c031a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7e222db0-0959-4fcf-ba38-c01133e92e31",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "88257961-5cc9-4390-87d9-f3272ba96c45",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-30T06:50:31.6004265+00:00",
"db_currency_id": "4fda8924-38e0-44f1-ada3-575b79815457",
"db_currency_code": "sample string 10"
},
"company_type_id": "9913c522-6382-4afd-add3-f013226f5c61",
"company_type_name": "sample string 32",
"company_type": {
"id": "2c2dafe8-cecd-408e-a28f-ce92153fcb80",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "112ff1ac-cb72-4785-8d1a-1956badfb12a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9c017c06-b5d0-47ab-a5cc-469396015e8d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "79813af4-5704-49ee-932f-b43b8ac28962",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0e0ddc2e-aa61-48d5-a2b0-d0bb02479499",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a73f7a2-03eb-4267-8ecf-7b382234e161",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-30T06:50:31.6004265+00:00"
},
"company_sector_id": "bb9da9aa-8f58-4e89-ba5b-21e44147c8fc",
"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": "3950b163-6edd-4b91-85a0-f210692baf35",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fe0703de-5f09-47fc-bd5f-6c62bcf93039",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c98e92ea-1b7b-4aa0-ac31-ceb421f0bb7f",
"account_manager_user_code": "sample string 56",
"company_status_id": "806e08d2-8133-482c-aca1-8bc14531abb4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-30T06:50:31.6004265+00:00",
"id2": 60
},
"db_language_id": "8613eb4c-c7a5-40ae-8c1e-d97dde81daef",
"db_language_code": "sample string 7",
"db_title_id": "f4933ede-e452-4539-a280-47584b7fcc53",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-30T06:50:31.6004265+00:00",
"create_date": "2026-08-30T06:50:31.6004265+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-08-30T06:50:31.6004265+00:00"
}