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
{
"id": "ec00293e-e5b8-4719-ba3f-32aa4bfce6c1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "41aa7dcd-5df4-466c-bfd5-c22045eb09e4",
"company_code": "sample string 5",
"company": {
"id": "11aaa683-f77c-488c-92e8-fc4bf35757bd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-17T20:56:00.2813587+00:00",
"sales_territory_id": "5bb27607-6149-4dc6-9c96-17dc3ba0f16a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d14e9021-5848-4b83-93c7-6a18ccbdf29f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bced50d6-e2db-4245-9b9c-5062e5ea4f8e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b34ce03d-9eba-4e24-a3df-4e08b8a1ade3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "970ff690-ef5c-421c-80a1-7dbb7815cd30",
"db_currency_id": "2030b3ff-ae39-4a1c-8b1e-15b1229edc0b",
"db_language_id": "99d9929f-05a8-4fb3-aabf-b2771d973593",
"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-11-17T20:56:00.2813587+00:00"
},
"modified_dateutc": "2026-11-17T20:56:00.2813587+00:00"
},
"marketing_segment_id": "ef36bcfa-4874-4c83-af2b-bf4ebe6960c0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9fa0e7aa-1af3-4309-a71a-4a73d3e6a946",
"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": "612f6dbd-fd36-4d68-a522-1c9d5eaf850b",
"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": "38d36bb5-7a50-4b47-ba9a-872cfe6d45a0",
"db_country_code": "sample string 28",
"feelist_id": "6fe286d4-b6ab-4be7-b282-dc365ee06ff7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ecb6f283-c6f8-479c-8bee-e2266e38b922",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1ec4f83b-14a5-4844-9f7d-f1a9462ea851",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-17T20:56:00.2813587+00:00",
"db_currency_id": "7b9790bc-835c-49a5-900d-e6955d8eda23",
"db_currency_code": "sample string 10"
},
"company_type_id": "366ae060-baf2-4f05-9778-508c23b90411",
"company_type_name": "sample string 32",
"company_type": {
"id": "ba0340a2-4c2c-4ee3-ac67-a82ef83f1947",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f9e22404-d8ec-47c0-bc07-0c197a9c6546",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5023da5f-dfa5-4d22-aaf1-2a4f471c2167",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "09e432f0-c326-4d90-9570-981693eaa008",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "db94a120-7012-46fd-b4c3-d1733b207392",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f9f59844-b6fb-49cd-905b-edf7ef134f11",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-17T20:56:00.3007947+00:00"
},
"company_sector_id": "15a66cf6-14eb-47a0-94ae-29e978846e28",
"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": "2b818616-5535-4580-85c8-47acfa09b6fc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dfaabbc1-6545-480e-9134-d7b5f6455ee5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3feaa65b-0478-4084-80c1-9e38ecb009f0",
"account_manager_user_code": "sample string 56",
"company_status_id": "e03c2754-d63d-46bf-805f-add516d49be0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-17T20:56:00.3007947+00:00",
"id2": 60
},
"db_language_id": "2d6b53c5-e90a-4162-9fec-4fa064ecfd40",
"db_language_code": "sample string 7",
"db_title_id": "fd5bac11-3a72-44da-9606-f5d81af78767",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-17T20:56:00.3007947+00:00",
"create_date": "2026-11-17T20:56:00.3007947+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-11-17T20:56:00.3007947+00:00"
}