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": "9fbc0079-da8a-41b4-bafb-246a3147d42c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "283fbac7-3051-463f-b926-c5c4f557951b",
"company_code": "sample string 5",
"company": {
"id": "b1b6b32f-61c3-4a06-b762-cc4b0693362c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T01:42:15.4294054+00:00",
"sales_territory_id": "a8c17b10-d548-4aed-b8e5-eddab69f868d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "64a34d1c-19f1-437a-bcf7-272e00e7fe32",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c109e1e2-4369-4bbe-86df-a73736b0ca58",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d42c5ecc-0bd9-4ec5-ae0f-0e77ccdb4f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a9da610-5a03-4ee1-9939-4d6f6a7b0578",
"db_currency_id": "22c49a77-a232-4713-be2b-72291315c1fe",
"db_language_id": "3239aa90-2982-463f-967a-ba16ac533899",
"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-08-10T01:42:15.4294054+00:00"
},
"modified_dateutc": "2026-08-10T01:42:15.4294054+00:00"
},
"marketing_segment_id": "24b24a68-3e6f-49f2-9305-b3aaed50be5a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "355f1cd4-e33b-4be8-8d8f-1be37e6503c0",
"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": "e4d55066-5867-444c-ab4e-7cb0282c6f28",
"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": "c2d79ff3-97c6-4a95-ae22-c7e4eabf9002",
"db_country_code": "sample string 28",
"feelist_id": "dc864786-a373-443b-ae03-dcd479146ab3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "588c5739-02ab-470b-8e78-722c3b4ffb55",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9b4fb310-cdb7-4e41-9647-07e0aff94d2f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T01:42:15.4294054+00:00",
"db_currency_id": "55de4f8c-e990-423e-90cf-152c069e0023",
"db_currency_code": "sample string 10"
},
"company_type_id": "a19f2f4d-8f21-4468-bd64-288bf94d4e54",
"company_type_name": "sample string 32",
"company_type": {
"id": "8f65c69d-6b99-4879-b852-a5e2b34b7192",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0ee2480b-6e39-4284-a3f2-05b155ec4a6c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "94ee3b19-2711-4321-994f-f4112b194f1d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c4ba3865-1e58-4abf-bf9b-e405d03d686e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7961647f-6c87-4576-9ea0-994f2127367b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1572194d-265a-4694-8f97-27ee6cb57a68",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T01:42:15.4294054+00:00"
},
"company_sector_id": "9185b983-d07a-43ac-b788-aa525526de63",
"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": "bb392e4e-bf1b-4bec-b13c-451f5855da51",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e0491783-f05e-4c21-99fc-90a8a49d54c5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "83f25236-89ff-4456-9d90-062fd46a6a7d",
"account_manager_user_code": "sample string 56",
"company_status_id": "5e0d5103-b7df-4204-8a26-23cc5e2f0abc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T01:42:15.4294054+00:00",
"id2": 60
},
"db_language_id": "ae9120d7-f79a-46f2-b91a-4684b752ce8c",
"db_language_code": "sample string 7",
"db_title_id": "6fdb67ed-ce00-4b2a-8707-31ec18f2ac6b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T01:42:15.4294054+00:00",
"create_date": "2026-08-10T01:42:15.4294054+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-08-10T01:42:15.4294054+00:00"
}