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": "35e7afb0-1f86-462d-bf39-cdb1d8f0b32a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f0ca8022-b53d-46c8-ba21-9d390267f365",
"company_code": "sample string 5",
"company": {
"id": "0fc6be01-bb7a-4ada-ab6e-3239a75ab953",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-19T00:17:32.6697946+00:00",
"sales_territory_id": "ab1705bd-c8b9-4358-bae3-4a165d6a2f59",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bcc40b05-217a-44a5-a22a-3de511cf6a43",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e7d9d8b4-c9b9-45e7-aae1-9d2ce7b33ee5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "164624b8-9cff-42eb-99f4-6fb1578e501f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f50bd755-10b8-4b1b-b9c1-a5e8aea065fe",
"db_currency_id": "4390ab7e-2987-4689-b173-504c809350d3",
"db_language_id": "0dc4be4a-2216-42c9-8e35-569d9576432b",
"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": "2025-07-19T00:17:32.6697946+00:00"
},
"modified_dateutc": "2025-07-19T00:17:32.6697946+00:00"
},
"marketing_segment_id": "c4a37050-98d4-48c6-890a-ee0d3674b869",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5bd7fa1c-6324-4161-84a2-980955bb29fb",
"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": "03838696-7f95-460e-b582-04428de9826a",
"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": "e2a41f0f-16e1-40c0-9e66-b141bffa4c0b",
"db_country_code": "sample string 28",
"feelist_id": "fd2503cb-b425-4f86-a3c6-0067bdae7cdb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5d3b1880-fff5-43a0-8898-a330720f98ac",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b205ff69-ab91-4be4-8c0a-2d77b6ad3d00",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-19T00:17:32.6697946+00:00",
"db_currency_id": "af7a4210-2d48-4976-86c7-e42d62b3bed3",
"db_currency_code": "sample string 10"
},
"company_type_id": "cd2e25f6-b62b-4278-b0e7-11304bd0bdff",
"company_type_name": "sample string 32",
"company_type": {
"id": "ba7a1ee4-5af3-44ab-9c02-f98799c9dc6a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "24c39297-2bf2-416b-9d91-965e50cbe101",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fe6afc9f-2197-4aba-bbc4-162629ab5887",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0c234f7b-7d64-4f6c-b37c-f1d1cfb6efb0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a7a4e045-4b0b-4bd7-b9e8-e44a43084f3d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "777e7995-fcf6-40f7-8d68-83566e75e294",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-19T00:17:32.6697946+00:00"
},
"company_sector_id": "66f892fa-f08c-4659-a441-a5572a911389",
"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": "bbc101b6-6f99-4f81-8168-0e7b636aa929",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b9b6a33e-9c42-4de7-b1e8-df4ca04a56fa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "77c6ac34-075d-409b-9f4c-b290fc197274",
"account_manager_user_code": "sample string 56",
"company_status_id": "ace9e1b0-6a9f-4d22-b5ef-32b3db9a9d33",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-19T00:17:32.6697946+00:00",
"id2": 60
},
"db_language_id": "54fd1a79-badf-4dfa-b3e4-d5074eaa43c4",
"db_language_code": "sample string 7",
"db_title_id": "190006c4-e3e7-41ee-a664-d4e7457a3aee",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-19T00:17:32.6697946+00:00",
"create_date": "2025-07-19T00:17:32.6697946+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": "2025-07-19T00:17:32.6697946+00:00"
}