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": "a798424b-2a5f-400f-9150-56ceb0db5bfb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6037e99f-6e98-48c3-9f2c-425693bbcc3a",
"company_code": "sample string 5",
"company": {
"id": "61da2f27-672c-45f5-b7aa-917e32f559e1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-05T17:35:16.5930587+00:00",
"sales_territory_id": "0498cbf8-6cc4-4e89-a96e-d306005b1a85",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "afee87bc-2d10-497d-80b7-1028cccc95a1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "44c2c482-4500-436e-a5fc-9dd69d9a9358",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4accb760-403f-49ef-9729-a6d3d6a72e5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da26b86b-6ab3-4ba8-8573-70df430fb6c0",
"db_currency_id": "5cbfb0be-6cab-4471-8938-6fce12dcface",
"db_language_id": "233e1c30-fdc5-4d2d-96bd-2779f4a9419b",
"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-05-05T17:35:16.5930587+00:00"
},
"modified_dateutc": "2026-05-05T17:35:16.5930587+00:00"
},
"marketing_segment_id": "9430e6d8-40ca-4a7d-b3b1-d1f86bbd4612",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "33d52f56-2fa7-4e8c-8fbd-b0d25ffe9093",
"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": "a03aea95-a0f3-43c1-a2fc-5a4f92364ba3",
"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": "a4748dab-5e42-4aa9-9ded-9cf21e7c484e",
"db_country_code": "sample string 28",
"feelist_id": "76de508b-cb5c-4df5-9b87-15e9764e3a21",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4dc0dca9-0e51-4de5-a49e-b909501637d9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8fc7da5a-ebac-4cd9-9992-1f6df8aa449e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-05T17:35:16.5930587+00:00",
"db_currency_id": "2b904f51-e1e6-4b88-b139-87dedd27743d",
"db_currency_code": "sample string 10"
},
"company_type_id": "1e28b68e-93ee-4f97-b1ca-089edd015fbe",
"company_type_name": "sample string 32",
"company_type": {
"id": "d4691c83-03eb-4f88-a7b5-4dd3d192e1a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "85a06864-fb9a-4029-bee7-704f74a0b187",
"sales_organization_code": "sample string 5"
},
"db_language_id": "23e5c17d-5c60-468e-b2c2-e9d034aea7cc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7a7985f-356f-491c-a3b6-c2e34b27d953",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f993c11c-78d0-4ec5-8dea-55a741a2b820",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2f6a3d2f-c7bc-4899-a736-43a16ec25c81",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-05T17:35:16.5930587+00:00"
},
"company_sector_id": "bb3b9033-ca69-4feb-9db8-1798d8e3a76f",
"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": "6b80ce0f-7098-499a-aa3f-7c15b5f404df",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "63f945e6-9ef7-400a-bb8c-cc73e4d5d42e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "abf15989-d08f-4e03-b2ad-0ea3c6dc1a39",
"account_manager_user_code": "sample string 56",
"company_status_id": "c226d63a-63ca-493d-b658-837ceb519841",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-05T17:35:16.5930587+00:00",
"id2": 60
},
"db_language_id": "b0e32170-82b2-449c-b985-fa26230beab9",
"db_language_code": "sample string 7",
"db_title_id": "8c1220e6-6410-430f-a746-81fd1b499666",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-05T17:35:16.5930587+00:00",
"create_date": "2026-05-05T17:35:16.5930587+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-05-05T17:35:16.5930587+00:00"
}