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": "9e416820-d3b5-445d-94c7-29c69f9ed2b6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "75a48b89-75a7-4883-bbc5-3a68f6377f92",
"company_code": "sample string 5",
"company": {
"id": "878d83aa-fd7a-4285-8462-0e91458040d0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-14T09:13:51.2097576+00:00",
"sales_territory_id": "9c773d02-8ec3-461d-ba6f-ae60af561daf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "94a3befc-a603-434a-a0e4-3ae5ecc5408c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7e736370-0468-44bd-baae-32343f535908",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "834bb0b3-e5bf-480e-b413-b3328dd7f620",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b75f29aa-133c-4c90-95dc-01bedb5e4fbb",
"db_currency_id": "48967b93-c796-4330-b78f-ecbf559c2a8a",
"db_language_id": "eb39c501-909b-4b6b-a73c-8e4bc3a301cd",
"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-12-14T09:13:51.2097576+00:00"
},
"modified_dateutc": "2025-12-14T09:13:51.2097576+00:00"
},
"marketing_segment_id": "b1e7687f-5e4e-4a58-8b98-11d647942168",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ea7d4ad4-8f98-48f2-8d0a-9373d1808f37",
"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": "136f9a22-c70d-427f-92db-87ea341e991e",
"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": "43e0532a-9f8f-42c7-a3bd-99d32cec41d5",
"db_country_code": "sample string 28",
"feelist_id": "a2047937-e5ad-44de-a421-612cbdfeecef",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b1e9fb8a-d66c-4b13-97fd-40eded759ad0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d496f1a1-c7af-4d6a-b73c-36c3c11a634d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-14T09:13:51.2097576+00:00",
"db_currency_id": "db41c403-1b79-4951-bc76-7679785f9acd",
"db_currency_code": "sample string 10"
},
"company_type_id": "5f5e5a90-3c94-4d80-85d9-16cac3a60283",
"company_type_name": "sample string 32",
"company_type": {
"id": "36b209a4-4fb3-4874-9984-e638ce2f81f9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7a7b85e-c3ef-4482-83a6-e22baf4513eb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "55d11633-e64f-445b-9f07-ebf483749f7e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "70a86c2e-98bd-4404-91b1-e4117b44d28c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "45c7eb3c-9919-42b7-bf8d-b0f0bbde0788",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "64c04db0-43b6-4fa4-92cf-3a9689fa6078",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-14T09:13:51.2097576+00:00"
},
"company_sector_id": "2cd4b1e3-1127-4b7c-9e26-ae9f0b684cd2",
"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": "28d7e7f9-648a-4c7f-ad78-35752ab765a0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb0bb6e7-5f86-45df-a0d7-977c5b58254b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "21afb2ad-6b49-4030-8d87-61357b340f64",
"account_manager_user_code": "sample string 56",
"company_status_id": "38317ef4-26a0-4542-a99e-917eaac68fc1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-14T09:13:51.2097576+00:00",
"id2": 60
},
"db_language_id": "76ed7fd4-3c10-41cc-b081-ac3ef4725acc",
"db_language_code": "sample string 7",
"db_title_id": "9144c6b8-6cfe-403d-a0bf-3609bf6e2951",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-14T09:13:51.2097576+00:00",
"create_date": "2025-12-14T09:13:51.2097576+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-12-14T09:13:51.2097576+00:00"
}