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": "db1fb7c4-0b24-48d1-afe3-d0bdb7523c8b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d74aa1c1-aced-43da-8275-308f8de8071a",
"company_code": "sample string 5",
"company": {
"id": "1b2d3151-ba53-452f-ae28-0bc9eac9543f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-19T04:10:46.0332507+00:00",
"sales_territory_id": "9ac3534e-98b0-45c3-98c1-dc9f14f86c66",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "25a366e6-754b-45d5-91bf-7d9a0fcdcc3c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2a9b0b19-b264-4b38-b2f7-ed8aad2eeeab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3faec8ff-62ed-41ab-b180-27c275226480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3398223a-da12-486a-b1d3-b89f43f8b726",
"db_currency_id": "316dd147-872e-4238-b1d2-320aca44093d",
"db_language_id": "a5f7838a-d2ec-4d66-a487-485e8bf2f290",
"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-09-19T04:10:46.0332507+00:00"
},
"modified_dateutc": "2026-09-19T04:10:46.0332507+00:00"
},
"marketing_segment_id": "525bbada-006b-4926-a3eb-b0d90bd0e657",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6b3d732a-544c-4292-829e-679aafb9c734",
"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": "3dcafdf0-56c3-4410-b389-6cc5561cf0bf",
"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": "2aa0291d-7cfe-4f71-8cc0-663195b9cd0e",
"db_country_code": "sample string 28",
"feelist_id": "e64d8dfe-97e6-4acd-9ba3-a76b940d07cc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "111c57ce-6b07-43d8-8096-b60bef1f2425",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "08df3378-76b3-4b9a-b2b1-db003c723409",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-19T04:10:46.0332507+00:00",
"db_currency_id": "bafc18d6-3d2a-48ff-b2da-1c20950b0fac",
"db_currency_code": "sample string 10"
},
"company_type_id": "de197224-98a6-4e8e-a452-1df8063859ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "03358631-ac3f-41d1-a547-037426466dda",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90f1eec3-c2b7-4a5f-9590-b176651e3007",
"sales_organization_code": "sample string 5"
},
"db_language_id": "65495c48-10ad-418c-9122-53d4a849b07d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e2492b5a-7f00-4519-ac0f-31b95d04409f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "df6f5b13-44ea-4a42-9158-0bfe7702590d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "663347c9-11ca-41ad-80d3-9c8e23226444",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-19T04:10:46.0332507+00:00"
},
"company_sector_id": "f568c459-6353-4264-b6ea-446e35d16a36",
"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": "f06880bb-54c4-46f9-81af-44ea1a5673ec",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2768daae-838e-425c-9b1c-22de8fdcc580",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a3387cd1-5458-4268-b5ac-3226b88c9b33",
"account_manager_user_code": "sample string 56",
"company_status_id": "528a3ebb-3d12-41b6-8e74-4cfe65588bcc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-19T04:10:46.0332507+00:00",
"id2": 60
},
"db_language_id": "6746b46c-0c40-4330-acc4-ed4355a7c160",
"db_language_code": "sample string 7",
"db_title_id": "89e1f66a-d509-4697-8de7-9ed5413c584b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-19T04:10:46.0332507+00:00",
"create_date": "2026-09-19T04:10:46.0332507+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-09-19T04:10:46.0332507+00:00"
}