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": "543e9266-7424-411d-a88d-cc0b67de837f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "14de64b5-efc7-48d4-9041-ecededfa083f",
"company_code": "sample string 5",
"company": {
"id": "87058a2c-ad79-4ace-8998-00d2ddda1d82",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-11T08:41:17.1928768+00:00",
"sales_territory_id": "6d460e70-bde8-4d90-acd6-fb2236675cca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ffc964a2-470a-4f76-870e-55f30c809288",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67376eb6-9c12-4462-b6a5-ee7426f98092",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "668dfa15-b806-4fb8-ba17-99745b2f7242",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "153fc4be-044b-4c77-94d8-d275738c73b1",
"db_currency_id": "65bdb358-1acb-42cb-a6f3-b4983ca9a6df",
"db_language_id": "2962dd25-6cea-40fc-89e2-6bd201ee8d0f",
"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-11T08:41:17.1928768+00:00"
},
"modified_dateutc": "2026-09-11T08:41:17.1928768+00:00"
},
"marketing_segment_id": "3e58e70d-b4f9-4c3c-a3ee-d2bee009b20b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "63c60678-fcb6-420c-998c-cf287587ffc5",
"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": "44b16240-1176-4b6b-a54f-6d3ce516606f",
"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": "3f4ede3e-43c4-4d09-a31f-220077eec8c6",
"db_country_code": "sample string 28",
"feelist_id": "bd2a2c2b-9ee1-4493-a57b-0e4f7257dc8a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e75bd580-ea92-4ff4-900d-5efa99032968",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6b8289b6-59f1-4f7d-8ded-000bc5102520",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-11T08:41:17.1928768+00:00",
"db_currency_id": "15643f55-9a9b-480f-86a0-ccd1ae92084a",
"db_currency_code": "sample string 10"
},
"company_type_id": "bb538c4c-780e-4a79-9d76-3b5dcdfd7c41",
"company_type_name": "sample string 32",
"company_type": {
"id": "f7f6e932-f875-464e-b343-acd06599a652",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a32c60cb-c62d-4ef1-9573-a61c4be5d1b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f0fcf9f4-d433-4e0c-b105-29df24aafc9c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4f6db314-df3a-4489-bdcc-c8247570d2b1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bfd3a206-21a0-4b9d-9f96-d1aa34b1ec78",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b70722ea-6da2-4a22-a07f-0cbe3eac9fff",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-11T08:41:17.1928768+00:00"
},
"company_sector_id": "ec2a4792-a523-4d1e-a7ce-b2fbe5180c2b",
"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": "c351b83f-6c7c-4977-b813-dac282aa333a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "20e87915-0db8-4e35-808b-d04dd1db97a1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "931865e8-f60a-4ff1-8ffb-1e2be96516cd",
"account_manager_user_code": "sample string 56",
"company_status_id": "faf97107-21b4-46c2-87d5-ccd501345d49",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-11T08:41:17.1928768+00:00",
"id2": 60
},
"db_language_id": "919a9c99-ca27-44e7-9238-085b2c59cb48",
"db_language_code": "sample string 7",
"db_title_id": "46527088-9f71-48b3-af9c-6103dea036ad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-11T08:41:17.1928768+00:00",
"create_date": "2026-09-11T08:41:17.1928768+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-11T08:41:17.1928768+00:00"
}