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": "d67e803d-9008-47ce-8ab9-e87f94fcfcca",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e16c2538-ad5b-4066-b972-345dc0127591",
"company_code": "sample string 5",
"company": {
"id": "411ccccf-c64e-498b-9cc6-63187c8094d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-09T09:04:34.3926061+00:00",
"sales_territory_id": "1c389687-1a66-4b3e-9fb7-d557aa0cc42b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2275b774-3b32-432e-800d-94cd9f163dfb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1930d277-aad6-420d-8b95-a0b6af3868fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a72f1f5-cd9b-4c3b-ac75-178bd18ee8e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30c574ed-a291-43a5-b2d3-2baaff647dbb",
"db_currency_id": "152152e8-b0b4-4e98-8deb-d1e190ef604d",
"db_language_id": "62a7d1b0-9433-4aa6-9344-a65c50b88303",
"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-09T09:04:34.3926061+00:00"
},
"modified_dateutc": "2026-09-09T09:04:34.3926061+00:00"
},
"marketing_segment_id": "2938fefe-e0b8-4912-92c4-dc4e448da769",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "195b315c-19b0-42a4-b8c1-72718a2c800b",
"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": "9409fc18-066d-41f1-a204-833a0d892221",
"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": "8f5b3639-11a4-4642-ba2f-59f0c136732d",
"db_country_code": "sample string 28",
"feelist_id": "90c59a4e-f551-4b6d-9c45-85cef64f6c55",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "96e0bc26-be7a-4bc1-9d18-a0776d8cef4d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a50e3a6-b59e-4c82-bc23-f57218622eaf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-09T09:04:34.3926061+00:00",
"db_currency_id": "6f743424-d428-4099-a89d-ca91bf555774",
"db_currency_code": "sample string 10"
},
"company_type_id": "5410a53a-3929-452e-bf3e-258cb004d565",
"company_type_name": "sample string 32",
"company_type": {
"id": "b9aa099f-2dd8-4c63-b261-62d2b6a27ad2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f47c75b-0e60-4bf0-9922-a936947afe38",
"sales_organization_code": "sample string 5"
},
"db_language_id": "56c7d87a-6b7e-4e30-a6cb-3d8e069d2873",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a27ac191-2473-4ed0-9931-f132550ad4ec",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4b2333ba-d4f9-4b4f-bdeb-6c02bcbef726",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "12110aef-2bd6-4ed4-9709-21aa072b3350",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-09T09:04:34.3926061+00:00"
},
"company_sector_id": "d5f4bfc4-a46e-4406-bf33-7c1aef9f194d",
"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": "6cb64073-0a38-447d-a7ae-6f528990a5cc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3b02d421-2fcb-4b61-a8f6-ce222570859b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8bd1aca6-65a3-4ef0-b3c2-1a1966273c4f",
"account_manager_user_code": "sample string 56",
"company_status_id": "a0b5c0e0-374a-46cc-ac52-c0606b0994cc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-09T09:04:34.3926061+00:00",
"id2": 60
},
"db_language_id": "bce2de5e-34f7-4ade-90cc-da95adfdd019",
"db_language_code": "sample string 7",
"db_title_id": "d8d494b6-6c5e-46e0-a653-c4cd3c5c9679",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-09T09:04:34.3926061+00:00",
"create_date": "2026-09-09T09:04:34.3926061+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-09T09:04:34.3926061+00:00"
}