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": "46c3f23a-e6e8-43b3-a8da-284712aae7ef",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6c5df42a-b4cb-4d06-8f17-c09004d89b5f",
"company_code": "sample string 5",
"company": {
"id": "0514f080-5e47-462c-8bac-fe34c1e100fd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-31T19:28:51.9493815+00:00",
"sales_territory_id": "ccd21458-e610-411c-85f5-9f87fc690c12",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2049f20b-f7a2-45ad-b280-c3a0b871e80e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f2c682d-a4ba-42c4-872c-bb410f4069ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e990148f-2479-444f-8da3-9f9dcb5003ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "458a70fe-4ea4-49a7-be18-73351922024c",
"db_currency_id": "2ffef8ba-37b8-455b-a889-fb04cf332d15",
"db_language_id": "b4d61980-6a88-48a4-996e-a5ab1651f98f",
"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-31T19:28:51.9493815+00:00"
},
"modified_dateutc": "2026-07-31T19:28:51.9493815+00:00"
},
"marketing_segment_id": "4c9b9b19-3987-457d-bfa6-77daf6157376",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "225b596e-54f2-4759-9687-f92ec44fb6d5",
"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": "fcecc80b-b2ef-403b-b248-9fb587222a1f",
"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": "6803b232-945c-43e9-9419-e324689943b5",
"db_country_code": "sample string 28",
"feelist_id": "904f9654-9f6a-43cd-907d-4015a3fae959",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "44929af8-8242-43c7-8c32-e9cbae8baf97",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "843b3e67-72ff-4b02-b68f-3b94f27a37b4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-31T19:28:51.9493815+00:00",
"db_currency_id": "c09c92c7-68e0-496a-8df7-142a0ceebaf7",
"db_currency_code": "sample string 10"
},
"company_type_id": "0062ed11-ce36-41b1-8102-a6e2fb30c6c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "27ea3747-e8a3-4aba-973a-70d5cb18943b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "62332f07-d9a9-495d-b072-caee7e98a67f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "af5fe0bd-0e4c-450b-bd2d-04fabb199557",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "44f3e183-4a3b-4310-b66c-12dda873c6f2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "411f15c1-6dc4-4ce3-ba20-2fbbc8ebb529",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c04f0b5d-0ddc-45cc-a48a-9506ffb8dbfa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-31T19:28:51.9493815+00:00"
},
"company_sector_id": "531735ce-2e65-43a6-a55c-260c7eb6f917",
"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": "e65ca034-0fd0-4dfc-8462-fb172ef4c197",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5f17c612-5712-4581-9448-99f1fae5d23a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5934dd49-55f6-4365-acd3-dd5433d239db",
"account_manager_user_code": "sample string 56",
"company_status_id": "4bd1da46-e618-4936-9f59-8af98e729c21",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-31T19:28:51.9493815+00:00",
"id2": 60
},
"db_language_id": "251bdc0f-c443-40de-9321-90ede9a61da7",
"db_language_code": "sample string 7",
"db_title_id": "47b2b3a3-badd-41cb-90b4-82c1a05f1048",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-31T19:28:51.9493815+00:00",
"create_date": "2026-07-31T19:28:51.9493815+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-31T19:28:51.9493815+00:00"
}