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": "3d3716e9-5588-40f1-9e9c-9d0b3474bbfc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "94eb69de-9efb-49a5-8b78-5b70dcdcf231",
"company_code": "sample string 5",
"company": {
"id": "d64b233b-afca-4542-a81e-2e0bd9ced10d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-01T07:27:53.9949659+00:00",
"sales_territory_id": "f9ad27ad-8c61-4ec7-b49d-de936336c70d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0484ada5-8b68-4df4-bf15-564703203e08",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "706674a9-6483-4107-8f76-014f8d4280c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1c1f49e9-dd07-496c-849c-308580859f69",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f5cd01-2a68-4f87-8f68-024b3c426d5f",
"db_currency_id": "14fb039a-c0a4-441f-ac3e-d75ee7974374",
"db_language_id": "f2eedaa8-3021-4800-9a9a-c9a60f7263f1",
"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-07-01T07:27:53.9949659+00:00"
},
"modified_dateutc": "2026-07-01T07:27:53.9949659+00:00"
},
"marketing_segment_id": "a1676ec3-c6c7-4b05-96e3-eca988b21f45",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f3103f1e-6992-4978-b520-53d1a45e49f0",
"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": "052c8efd-3edd-40d9-b7ac-41bfb4853290",
"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": "ef5e9ddb-b121-446a-b187-8fe6298e23ba",
"db_country_code": "sample string 28",
"feelist_id": "78544336-25a2-439f-8f93-7279a7d09ea7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ca3ea170-ddcd-4c4f-bd45-91048ee19d13",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6f534d54-600d-4f12-8faf-41b2b35a7e9e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-01T07:27:53.9949659+00:00",
"db_currency_id": "0fb650dd-a768-426a-b40b-53cc191a6c89",
"db_currency_code": "sample string 10"
},
"company_type_id": "498de812-7006-4549-a9ae-7dfdf5dcdbe5",
"company_type_name": "sample string 32",
"company_type": {
"id": "b4bb7847-5113-43ab-b393-209fabaf0bbf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "589ceb6e-6370-4633-8a08-595c73975329",
"sales_organization_code": "sample string 5"
},
"db_language_id": "178f7327-40f4-4db0-b421-0883a839a3cc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "52ad2155-78ff-4038-b53a-ae9597a56f71",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6d09cd5b-4886-44d5-bf7e-e6dec581ce51",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5456734c-11a7-4c88-a735-454861d31b2e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-01T07:27:53.9949659+00:00"
},
"company_sector_id": "4177f25e-c4bd-4fa3-9fe7-710bd4d3f605",
"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": "8ebf61ef-d80e-4271-8cd7-de255bd08c62",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dab0abed-5e5e-42c0-a770-77a1586f7459",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1d416df7-7b6b-40e2-a377-52c77d3052c6",
"account_manager_user_code": "sample string 56",
"company_status_id": "c5e5407e-4cc2-4dba-96e3-0db218411f0f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-01T07:27:53.9949659+00:00",
"id2": 60
},
"db_language_id": "3d798935-723f-4776-abda-c3078a251ec9",
"db_language_code": "sample string 7",
"db_title_id": "636e0ec9-75db-4615-99f5-ede535948f44",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-01T07:27:53.9949659+00:00",
"create_date": "2026-07-01T07:27:53.9949659+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-07-01T07:27:53.9949659+00:00"
}