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": "7d237996-117c-4962-a48e-48a803606039",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "58c93550-b1be-4ed2-a76b-09e5f16dd62d",
"company_code": "sample string 5",
"company": {
"id": "c302359a-7a02-4670-855e-90c4066aed17",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-23T07:21:26.4987824+00:00",
"sales_territory_id": "11a74c27-0cb2-4f76-ba15-61aa49c963b7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "86e11df1-377f-4c1b-8e59-17114824033c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f6c574b-8235-4b64-b143-236b584dc3c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9505e107-c257-4db3-943b-bfcfaf3df033",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29c5701d-fac3-46f2-8222-49564324bba5",
"db_currency_id": "5b0e5c70-8dce-4e50-8992-e521e64b81d3",
"db_language_id": "9e327ec6-7ceb-4fdd-8dbb-46ec142c4db7",
"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-23T07:21:26.4987824+00:00"
},
"modified_dateutc": "2026-08-23T07:21:26.4987824+00:00"
},
"marketing_segment_id": "ee971b5b-abc4-4184-b61e-fff6e58fd1da",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d6514516-dffd-4613-a07d-ca79de4190db",
"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": "018b5da8-56ba-4aab-8cb5-59b1e875a5ce",
"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": "d3979fdb-1403-434d-ad5b-4c8ed1ec1dbc",
"db_country_code": "sample string 28",
"feelist_id": "8b2eb1c4-a670-4bf1-8b93-2c75ee651c51",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7961652c-9db1-4852-a6f7-6a82d3089bbb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "364cd5dc-6d33-48d3-ba7f-b2eddb99e74f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-23T07:21:26.4987824+00:00",
"db_currency_id": "70ab39a6-76e3-43da-85e0-d0bece79d4c8",
"db_currency_code": "sample string 10"
},
"company_type_id": "8f218826-edbe-42cb-8d2a-c91a4d43dce9",
"company_type_name": "sample string 32",
"company_type": {
"id": "1f0d3d98-c608-4d66-ae91-84fb57821227",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "54b2d7e8-5759-44e6-813b-9e1b676fbc8b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f1c1e6ed-137c-4884-a689-22345eb59316",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f31ba0e-ee11-44fa-bd08-2388072715b2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c6deb26c-17b2-422e-b56e-786771cd5856",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f281ee7b-1d9a-4820-a991-91bb64083a4e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-23T07:21:26.4987824+00:00"
},
"company_sector_id": "6c000cd0-43a4-4437-8d61-ccecd5e3669a",
"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": "412b7180-1685-4644-9827-34953c12a2b9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "458aec20-1931-49c1-b9ee-4fcfca74321f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8abf7fed-46f9-4a6d-bdc8-d7bb9c6cba96",
"account_manager_user_code": "sample string 56",
"company_status_id": "cca16f09-91fb-4ac1-9084-abc15592292f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-23T07:21:26.4987824+00:00",
"id2": 60
},
"db_language_id": "07df525b-78e9-489d-9daf-e90bffd02a9c",
"db_language_code": "sample string 7",
"db_title_id": "97dcc38b-7f1b-47c1-befe-dbea337c19c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-23T07:21:26.4987824+00:00",
"create_date": "2026-08-23T07:21:26.4987824+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-23T07:21:26.4987824+00:00"
}