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": "a3a12f64-f9c4-4075-93c4-45e6be7eefe2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f7c37ef5-e7be-4a14-94d0-beaf586a6f31",
"company_code": "sample string 5",
"company": {
"id": "02243e8a-549c-4a39-8f5b-9e92f79b43ee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-04T23:26:55.9857463+00:00",
"sales_territory_id": "8f1a1805-777c-4eb3-9ad7-158b7a6659e5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "924dfd40-3055-43f5-baa4-4b515436a4dc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c2e2c82-98f9-4a9d-b94b-e380068a3762",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a019ce95-b560-489a-bb27-776073e908ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7439ca-cc1e-47a3-b3d4-693263679f19",
"db_currency_id": "d1d7755d-5d30-43eb-a9c7-bc6237bde24b",
"db_language_id": "4ddfbee4-c6f6-49c4-b6e1-5fb2fb6d3066",
"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-07-04T23:26:55.9857463+00:00"
},
"modified_dateutc": "2026-07-04T23:26:55.9857463+00:00"
},
"marketing_segment_id": "e349180d-4ecc-4839-9c30-898051066bbf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "37f2d0cd-aef3-4001-bbe5-4546f7f3982a",
"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": "ab61922c-e767-4721-8ede-a26882136877",
"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": "1655506a-63b8-407e-872c-867dc0f27b8c",
"db_country_code": "sample string 28",
"feelist_id": "9fedb200-b0a3-4a05-84fb-acc1bde3eda1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e9f1ea66-880c-46b0-8253-91914f7dc6f2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0ee949c1-383c-49f2-88c6-e9de41797e50",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-04T23:26:55.9857463+00:00",
"db_currency_id": "e3a68a6d-25a2-4dfd-8f99-749c1740d163",
"db_currency_code": "sample string 10"
},
"company_type_id": "4347b4ec-41ad-42c8-a207-c32340a783a5",
"company_type_name": "sample string 32",
"company_type": {
"id": "b0122249-2282-4ef5-8083-01ebae0443c5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9db0675e-50d7-4bd2-b6ed-21cf9651d60d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "52b2e272-5982-4371-86c4-42e1081c51e1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "57f93273-18b9-4dd6-933e-f1737dde2438",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6159ab37-3a86-4151-99a5-c2412806a35f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "11ae40b9-0d45-4e5a-899a-755cf1481831",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-04T23:26:55.9857463+00:00"
},
"company_sector_id": "7838be24-4155-4bd6-903d-f764588d3f69",
"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": "f60b492d-7bca-4a0b-8ee4-255b772ee424",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a493902f-2f1f-4329-af96-fb5c95789589",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d437269d-0ec0-45af-81b2-ac3c5099f781",
"account_manager_user_code": "sample string 56",
"company_status_id": "df773f9e-990a-4a0e-89b4-ecf2bddc9b10",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-04T23:26:55.9857463+00:00",
"id2": 60
},
"db_language_id": "2d42eea0-a8f3-454d-8842-70e95e434a84",
"db_language_code": "sample string 7",
"db_title_id": "f3bb97b7-f3d1-406c-b8e5-1666ff2b0209",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-04T23:26:55.9857463+00:00",
"create_date": "2026-07-04T23:26:55.9857463+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-07-04T23:26:55.9857463+00:00"
}