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": "83e3054f-b38f-4f82-8a85-d4de5b641eb1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5c42fd4b-32e4-4881-bc09-b73a3ddc840c",
"company_code": "sample string 5",
"company": {
"id": "32e13b8e-0394-4d45-892c-46c34b71daa4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-03T03:34:33.6960047+00:00",
"sales_territory_id": "ace84369-5419-41b9-81c2-36bfc2e9e81f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "efa4a36d-70e2-4ea4-9ec1-3a903ef0c8d8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eacb5422-2266-4717-bedb-10a3d7653e35",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "37e3b305-a76a-4d4d-8470-6c547a477b53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57dcabe0-4915-4778-b281-ae28e2488c5d",
"db_currency_id": "107d8e7c-4514-474c-b20d-089da6a12f86",
"db_language_id": "b9dc69a5-6b03-407c-9aef-250549653973",
"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-02-03T03:34:33.6960047+00:00"
},
"modified_dateutc": "2026-02-03T03:34:33.6960047+00:00"
},
"marketing_segment_id": "d5b87056-6550-458d-987a-9fe0546a5d3a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "413b308b-f4dc-42c1-9e78-8bad493c8117",
"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": "3902a719-ad86-45ad-9625-43a23e54f32a",
"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": "19b86cab-59a4-415a-9948-e316adb8f459",
"db_country_code": "sample string 28",
"feelist_id": "4cd5938e-8c75-44f5-8aaf-4aced4048ce0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "87fde3c9-fade-4945-bf6f-fd8db2bd45f8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "13579e48-b7fb-4c3f-ae7b-e5017aee0848",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-03T03:34:33.6960047+00:00",
"db_currency_id": "576e8985-00d8-4b6b-bba3-3198b3c0efe2",
"db_currency_code": "sample string 10"
},
"company_type_id": "46470118-0157-479a-ac10-f3c8b93a9aa3",
"company_type_name": "sample string 32",
"company_type": {
"id": "2e32bb91-54db-4965-865a-2a67cf0e24ef",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "57c12da0-45f4-4857-bcff-586edd09b662",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bf85e3c4-b78a-491f-bb0e-d09fa2c21a3a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "efde54aa-68df-42f9-bce0-f0f25a2cc11c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a847b1e3-c15e-4558-89db-0aba45196990",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c7b8ac73-3a02-492b-9b3c-988efaaa33af",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-03T03:34:33.6960047+00:00"
},
"company_sector_id": "4084bd64-a450-4c2d-a48a-48e9312d36cd",
"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": "842665ea-0366-47d6-8bbd-8e0e30d7d94e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eb5db364-cb14-4b27-b2a9-78c92e37b832",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ce935c60-f496-4b2d-bab7-2cb8ab9f4831",
"account_manager_user_code": "sample string 56",
"company_status_id": "496a5de8-ae8c-4eac-b9a5-baa7dc427b30",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-03T03:34:33.6960047+00:00",
"id2": 60
},
"db_language_id": "8589d6ba-6765-4831-9539-c68ec7027a14",
"db_language_code": "sample string 7",
"db_title_id": "fbfd2899-dcd1-4ef7-bbb4-8b4dc1e9c721",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-03T03:34:33.6960047+00:00",
"create_date": "2026-02-03T03:34:33.6960047+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-02-03T03:34:33.6960047+00:00"
}