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": "cb147ff1-93b7-4f6c-981b-85e0995207f5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "50be5210-e1c2-4760-a6b8-4cc4b2f3e808",
"company_code": "sample string 5",
"company": {
"id": "8c9f643d-1da7-4103-a4f4-62ec43ef089e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-30T22:46:41.2227693+00:00",
"sales_territory_id": "4f545bdd-d384-461a-867c-558464eea97d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b14ca13f-6148-4f88-8da6-1e0bcbceafed",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f0a4b24-31f2-4ac7-bc28-4ea74ffc10d7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3271c263-7f56-4c29-9d62-0091daa1076e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f53d70e3-db33-4c38-9d17-cd5557811b5c",
"db_currency_id": "45d8e09c-bba5-4d6d-ac65-388d2deff7f1",
"db_language_id": "a985deb4-8f04-444c-b994-70bc44f3f8c3",
"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-30T22:46:41.2227693+00:00"
},
"modified_dateutc": "2025-12-30T22:46:41.2227693+00:00"
},
"marketing_segment_id": "e844af42-18dc-4e02-8b3f-7e74af64d4f7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c1f22910-ad67-4f9b-a54b-6f49254f18b7",
"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": "015fb6c8-7150-4c4d-9e10-ae45e5306c3d",
"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": "28f0ba55-ab9e-4a68-abd2-007a84498053",
"db_country_code": "sample string 28",
"feelist_id": "6c4357ee-9048-49af-9849-68d7a58ae908",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e0f0c716-f70d-4bd4-a45a-f98ba963f2d4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "413b51bd-efd3-4af7-a08e-9ba1e648dfbc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-30T22:46:41.2227693+00:00",
"db_currency_id": "ded9f7d1-164d-47bb-8098-af2a75f5c5b7",
"db_currency_code": "sample string 10"
},
"company_type_id": "51a65a97-e89d-4ea2-a2e9-30130f455d34",
"company_type_name": "sample string 32",
"company_type": {
"id": "fda5ab74-2396-48e0-a1d3-4d188a678b93",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2b677ba6-cc61-44f7-8164-81fe400fbc55",
"sales_organization_code": "sample string 5"
},
"db_language_id": "72d1cbe7-b8bc-4e29-9b7c-b7ca4020618f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c2ab4d21-1769-4859-b679-48afe17b89b5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "06d9400c-7288-472d-b538-2716e9351307",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "771bb9da-8f32-4a09-85cb-8cc6bddd7539",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-30T22:46:41.2227693+00:00"
},
"company_sector_id": "500e1c66-b78a-4964-b020-1d4ccfd4823b",
"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": "f811fa66-ec79-4478-a529-8d09648d1f2c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5f721373-63c6-4a5f-92d8-7a9f85cc0336",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "94f5ab6b-e327-4cde-8c40-f3fa46a42a24",
"account_manager_user_code": "sample string 56",
"company_status_id": "21731f82-6467-4c20-83a5-cae4310ddfb4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-30T22:46:41.2227693+00:00",
"id2": 60
},
"db_language_id": "15847653-f311-4fe2-8917-08311e6b10ec",
"db_language_code": "sample string 7",
"db_title_id": "dd4e68f3-65f6-4380-80b5-2e976f156951",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-30T22:46:41.2227693+00:00",
"create_date": "2025-12-30T22:46:41.2227693+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-30T22:46:41.2227693+00:00"
}