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": "98c4ca3d-b403-412a-8301-e8c15d3bc75b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4ffe953b-fee8-4c7d-bfe5-f061e6412cbf",
"company_code": "sample string 5",
"company": {
"id": "44d54894-8554-424e-8d8e-e64f9d96092b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-18T12:32:12.4363849+00:00",
"sales_territory_id": "b0faa6ff-d125-4938-bcfc-f23f2204768d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "474b3c96-00f2-4de5-9b5a-c13a3c77d58b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "463d880c-a011-44f6-8691-1e756a4d3584",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b776a6ac-51bf-44de-9839-14f79a31945b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "67336457-a340-4170-9737-87f45cc06f5d",
"db_currency_id": "01644599-c695-4257-86d9-432e5b7e8aae",
"db_language_id": "a7fa7320-0bfb-43aa-8d1e-595a4425e27e",
"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-06-18T12:32:12.4363849+00:00"
},
"modified_dateutc": "2026-06-18T12:32:12.4363849+00:00"
},
"marketing_segment_id": "354f514b-230c-4cd7-b0e5-e54663ee1b79",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5c968ffe-86d1-4939-8cac-db8e0192cc12",
"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": "f7fcf524-01ff-4be9-ad2d-bd6e30bef6a3",
"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": "750580df-b9d3-4f08-84c3-04098bb77414",
"db_country_code": "sample string 28",
"feelist_id": "dd95bd70-b9c1-4b17-b2bf-3ceb402cf291",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e731401e-1e07-4979-95f5-54e80b1ee6d3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a25d2548-4521-4138-a809-7f7f05d62c2b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-18T12:32:12.4363849+00:00",
"db_currency_id": "84af34c5-a2e7-4721-95c5-4b22dd851548",
"db_currency_code": "sample string 10"
},
"company_type_id": "6e21dbfe-9ec6-4fc8-8973-f70f493e4f98",
"company_type_name": "sample string 32",
"company_type": {
"id": "05e665de-590f-4807-8ae7-b040f9f5e43b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a994c6c5-f7d7-4ce3-86e0-457236fdfe76",
"sales_organization_code": "sample string 5"
},
"db_language_id": "559db62c-d196-4ed6-a469-4a3c68a3d322",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60f0fe5c-e7cd-4c6c-bd62-598abc6e3072",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f9b23d52-e2dc-4e72-8bfb-8c1e0f7c234a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2fdb4a4f-5e06-401d-935d-093a1a92aea9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-18T12:32:12.4363849+00:00"
},
"company_sector_id": "51940974-fa3f-4e89-b861-5a733c2fd008",
"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": "d0e33b5f-8628-4e45-aa90-1ab9997c38a6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "134a1fb1-1c4b-4ce5-a41c-411311c97932",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a132106a-1ff9-4727-9564-db41f542a8ed",
"account_manager_user_code": "sample string 56",
"company_status_id": "f6a26227-0e25-4ce6-b74d-5cf64ffe06f8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-18T12:32:12.4363849+00:00",
"id2": 60
},
"db_language_id": "f8ea61f8-3174-4564-9822-4a39eec8fe3f",
"db_language_code": "sample string 7",
"db_title_id": "b1b9dd91-3640-4de8-a0f2-f9373244be54",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-18T12:32:12.4363849+00:00",
"create_date": "2026-06-18T12:32:12.4363849+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-06-18T12:32:12.4363849+00:00"
}