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": "edef5f8c-4a7b-4fbe-8304-8c464619546f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc39515c-6698-48d4-8ef0-5ed62ec4bacf",
"company_code": "sample string 5",
"company": {
"id": "639cd503-41ba-4539-8b4b-072b01a898bf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-07T04:14:03.9172977+00:00",
"sales_territory_id": "93bbcbaa-695e-40f5-91f5-7f8375caefb4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "04ed2e20-33f0-43a9-9627-f01189cf86de",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fd2f328e-3ee5-4752-9e55-f4eecc3a8d31",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5eede1db-50b4-4a4e-a832-ef6a6e2fc3cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5620d83d-64b7-4322-a916-3eb0a9fc70ab",
"db_currency_id": "a16a0c0a-1554-4867-b538-3a2afd8f0955",
"db_language_id": "69b894cc-7d76-45ec-a0e2-da7e88e1e0d4",
"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-04-07T04:14:03.9329196+00:00"
},
"modified_dateutc": "2026-04-07T04:14:03.9329196+00:00"
},
"marketing_segment_id": "4ed6fd8d-f2e9-4003-b06a-00eb70120724",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d1e1287f-70c3-48d3-a8f9-2fec35515daa",
"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": "2fdec271-7466-4a59-a28d-2f717ace74d0",
"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": "5e3abf38-ab38-4aa7-aa4f-55b8258d766d",
"db_country_code": "sample string 28",
"feelist_id": "34796a4e-661f-4354-b487-0e7eeec729c8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "823ff384-f16a-47e8-a6de-bbf0a10ec0ed",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ed1d6e79-fbf4-4c9f-a689-098285871602",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-07T04:14:03.9329196+00:00",
"db_currency_id": "43e01d11-dd8f-49f8-8c7b-0f3cb04cc48b",
"db_currency_code": "sample string 10"
},
"company_type_id": "41d993d7-d849-4f68-bcbb-badffaace5ba",
"company_type_name": "sample string 32",
"company_type": {
"id": "f06b489a-4d80-471d-aed4-eca0be68fa43",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3edd4b89-f4b0-473f-a19f-1d15cd95f36d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6afe8d87-0e52-4301-9ab7-7dfa5a757dfa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3d98f502-cc80-4a7a-8a2b-2a669462eb43",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4c65f68a-003d-4655-b366-f9414074847d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5af2548b-2571-40dc-9404-75a23199e324",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-07T04:14:03.9329196+00:00"
},
"company_sector_id": "9aea28ee-343c-4605-ba9a-687a422e856e",
"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": "5be77bb6-be29-46f6-86df-439c0a0e16b9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1f2d60a3-cfb2-4ff6-a66f-429ca3805034",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a10e421c-bcf3-4dc6-b52b-cf6b91f71abe",
"account_manager_user_code": "sample string 56",
"company_status_id": "0378b69a-0ba6-4018-beb3-f87ba05d47d6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-07T04:14:03.9329196+00:00",
"id2": 60
},
"db_language_id": "6b8d8cd7-07bf-4bf7-aed6-20a7fc6c31fc",
"db_language_code": "sample string 7",
"db_title_id": "73a427df-8b7f-465d-93f7-cbbb2b838fdf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-07T04:14:03.9329196+00:00",
"create_date": "2026-04-07T04:14:03.9329196+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-04-07T04:14:03.9329196+00:00"
}