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": "7db6fcad-3169-4b2a-84d5-b8eb37f8cbee",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "074e97bd-5522-4fcb-b590-224291924418",
"company_code": "sample string 5",
"company": {
"id": "d319e82f-94aa-4be3-88d7-926d7421e076",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-27T03:51:18.0031186+00:00",
"sales_territory_id": "a990778a-2239-47b9-8319-8bbb9820d503",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10c034df-4914-4e44-bdb0-c4a3fa3d156a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4b6d6102-c58e-4698-aaa8-e8a1c33c945a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4977f750-436d-4002-9809-d6684f061445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a403aa61-505a-4d9d-9342-c8056c61961e",
"db_currency_id": "e039edcd-000b-4705-bab3-40a686a732d5",
"db_language_id": "84c4b57b-da8f-47f9-a22c-12f6fac868ac",
"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-01-27T03:51:18.0031186+00:00"
},
"modified_dateutc": "2026-01-27T03:51:18.0031186+00:00"
},
"marketing_segment_id": "0f30fffe-ee43-489c-912d-6694c6133afe",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "aa3b5508-79c8-41e5-8dd2-f2d4a8b69961",
"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": "3eac9f6a-b883-4832-8452-49dcbd1864ab",
"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": "e339e156-454d-44ad-a836-84fd46e7307c",
"db_country_code": "sample string 28",
"feelist_id": "4ef11596-0ddc-4cd0-bb53-c09d38010753",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "02c1c186-8dca-4abf-a5d1-d31a96c68bd6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "46c0897a-833b-43ea-a98f-ea37d4004720",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-27T03:51:18.0031186+00:00",
"db_currency_id": "dd049a2a-d794-4236-a2b7-6bbe5d7e511f",
"db_currency_code": "sample string 10"
},
"company_type_id": "4bc5cf42-001d-47e8-b91e-740ec0a70375",
"company_type_name": "sample string 32",
"company_type": {
"id": "d986d817-716c-4ee7-a710-d96fcb1eabf1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0c48dbd-6bd3-4cd3-a239-a9c105cba9f7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1144d4d4-c8ea-4e09-aefa-e2985255e918",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7fa87faf-2800-4953-8185-488c072f505a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "684789e6-c471-4bc3-930c-2ecbb9b550b6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c70d574c-d495-422d-9fd1-bc06c6a40a89",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-27T03:51:18.0031186+00:00"
},
"company_sector_id": "f30beb04-13f2-49c5-b85e-282f4ef87ecc",
"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": "c71d4570-8228-4596-a657-b06f1e575cd9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7b2aee4c-5b6f-46da-82b1-297383d3014a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "62b06636-8337-41dc-a01e-f85b9ccb1e2b",
"account_manager_user_code": "sample string 56",
"company_status_id": "6d44de2a-4873-43ee-b564-3826c4fe2b3b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-27T03:51:18.0031186+00:00",
"id2": 60
},
"db_language_id": "a221bec1-2f79-4897-9460-bcfe837e1c0c",
"db_language_code": "sample string 7",
"db_title_id": "fd660814-1668-4cd1-8f64-5eaa79ca71b1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-27T03:51:18.0031186+00:00",
"create_date": "2026-01-27T03:51:18.0031186+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-01-27T03:51:18.0031186+00:00"
}