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": "eb6f5b76-214b-4a57-b27c-6f69acc9a575",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "76e4cf46-1c1c-4262-9a39-44d553c8250f",
"company_code": "sample string 5",
"company": {
"id": "bc26ac78-95f3-4f18-8140-3abdf876987e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-03T02:20:25.0966272+00:00",
"sales_territory_id": "5b0bedef-1291-4434-922d-74068cb8a800",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e7c7abc5-ac8e-438e-9e11-b18dddff5576",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "15bb638e-0a1b-4796-a410-bb719c4abd67",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c3069b74-ea34-4b35-b69a-3baffe118f0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a67b2b19-78c0-4d18-8591-2b3ae9b9f7f3",
"db_currency_id": "179db633-3077-4a7b-8094-bd16bc578bd3",
"db_language_id": "8a37d198-1daa-4656-a42f-3390a0142cae",
"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-12-03T02:20:25.0966272+00:00"
},
"modified_dateutc": "2025-12-03T02:20:25.0966272+00:00"
},
"marketing_segment_id": "2889a519-0c3d-42f6-a21e-4c4f81a64500",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f86b439d-64b3-42a5-aa7e-ad1d357fe427",
"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": "290bde85-ec03-4197-b704-c3818bb980c0",
"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": "ef2e60c6-2f82-457b-a06a-86f854dc2c87",
"db_country_code": "sample string 28",
"feelist_id": "68287c05-bdc2-47c9-a5aa-4947a06f8841",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "52e95330-c48a-416c-876e-e7a15ea7877d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2f69dd64-d926-44af-a646-4081997b7d13",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-03T02:20:25.0966272+00:00",
"db_currency_id": "4f7e8419-2734-4577-b69c-b18d6453504e",
"db_currency_code": "sample string 10"
},
"company_type_id": "f980878b-dc1a-4257-8a92-eeec68ec9408",
"company_type_name": "sample string 32",
"company_type": {
"id": "bb7feedd-fbc1-43ab-bc57-ebfb61a9b792",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1157580b-a552-4be3-99a7-8e3a5307b98e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "931c42fd-a8fc-49ae-837d-7131bedb91ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32cfb9f9-4dac-4cef-aada-50d7dda4afc4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "70d8edc9-9e4d-4b3e-ba2c-5769ed56f23a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "49c83ea2-3f56-4819-8eaa-cb367a579279",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-03T02:20:25.0966272+00:00"
},
"company_sector_id": "a78e1072-e8c9-43b8-8e3e-5119ce2726e0",
"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": "c5844bbd-ea9c-413f-aeb0-ba6fddb0187e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8a437293-d7ac-4f87-98e4-9930f151cc11",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2f18b8e6-8615-4bd5-afd5-3db42e2ad0fa",
"account_manager_user_code": "sample string 56",
"company_status_id": "26270152-437b-425f-80f4-78e393ea4481",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-03T02:20:25.0966272+00:00",
"id2": 60
},
"db_language_id": "b07f5b6e-d69e-41b2-a2ea-f1b8ba1cdae8",
"db_language_code": "sample string 7",
"db_title_id": "00cf3f90-4069-43a6-87fc-7badd91c3e4b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-03T02:20:25.0966272+00:00",
"create_date": "2025-12-03T02:20:25.0966272+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-12-03T02:20:25.0966272+00:00"
}