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": "695a0aa0-f0f4-4d91-9bc7-5b4431abde6f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8abe8b7a-f0bd-4b1a-b789-84edeee2f21d",
"company_code": "sample string 5",
"company": {
"id": "f958ab2b-675e-4174-88ea-2e087c14d246",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-30T09:50:55.3783651+00:00",
"sales_territory_id": "733ba42b-a237-461b-94c6-60161b7e12e0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "70e1ff13-bfcb-496b-91e6-8a397e725014",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d5652331-aead-473e-a546-c1ccca540885",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d3d2b932-f18f-4538-8e37-5f9eeba3c1c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f34435e-ff7f-42d8-a6e5-3eade3821bec",
"db_currency_id": "27e56171-0d86-4d85-b095-2c8c9461b45c",
"db_language_id": "7a2c32e7-e0cb-463c-ad65-51fc82596cc4",
"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": "2025-11-30T09:50:55.3783651+00:00"
},
"modified_dateutc": "2025-11-30T09:50:55.3783651+00:00"
},
"marketing_segment_id": "7be77143-3d61-4932-a70c-1e1ac9584f75",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6f10a0de-9588-4a63-9057-d5d26af982b4",
"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": "579a4091-ef8f-48ed-9f5f-c57561d98d4e",
"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": "cb445cb2-65c7-4ce3-b569-ab1357cd0532",
"db_country_code": "sample string 28",
"feelist_id": "2ff7aeb1-3bb9-4e8c-a244-90456810cfaf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f0a8b05b-14dc-4564-821e-58833ad7196b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fac0220a-d70c-43c7-9f06-74c29bedaf42",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-30T09:50:55.3783651+00:00",
"db_currency_id": "37e1a0e2-dd01-4767-938c-3de68b49b3fe",
"db_currency_code": "sample string 10"
},
"company_type_id": "57e202fd-3c49-47dc-8aba-8808599a80b8",
"company_type_name": "sample string 32",
"company_type": {
"id": "ca672371-d55e-4d62-b611-8ec1165dfb83",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "27ffe4cf-2df4-4f39-b78a-a51048586668",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3ce90522-2987-4d3c-bd89-81f2a529714f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4e2ae710-629d-40fb-990a-6e27e8760793",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5b330f95-6119-4833-b825-d1fb7f2619e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ab4c5833-572b-49fa-8cf1-0580b280ea4e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-30T09:50:55.3783651+00:00"
},
"company_sector_id": "563a08fb-c440-4faa-9e0c-07f53119fe1d",
"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": "d5a9cffb-4a19-405b-a510-fc35a9a9df84",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5b321e7f-f1d6-4bd3-b9d3-d42c4c05d9f1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f1ba07f3-7fee-4d5a-b847-488b9ea31475",
"account_manager_user_code": "sample string 56",
"company_status_id": "f5211909-16d4-4672-98ea-67ee21a36343",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-30T09:50:55.3783651+00:00",
"id2": 60
},
"db_language_id": "ac29d22a-eaf2-4c55-a603-0830bb401688",
"db_language_code": "sample string 7",
"db_title_id": "c73f6ac1-dd00-4fce-941e-2c1b2e6f485d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-30T09:50:55.3783651+00:00",
"create_date": "2025-11-30T09:50:55.3783651+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": "2025-11-30T09:50:55.3783651+00:00"
}