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": "6c41ab02-bacd-4848-b78c-e9668ce9c7b4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f848b197-720d-4889-8d43-7b3ff06243f9",
"company_code": "sample string 5",
"company": {
"id": "d8f6138c-eae1-41df-9336-beda6c69aaf6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-16T15:38:58.6440872+00:00",
"sales_territory_id": "926ca7ba-bf25-43a6-89e6-afac02e16703",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6747c128-2848-42d3-b953-a7201f357278",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4b7e3f26-1e18-41b9-a75e-d64d2ebc8310",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "99bbe2c2-cdeb-4f65-9e55-755872d6990a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "559daf4c-2653-42f4-bc2d-aa976f0664b4",
"db_currency_id": "bf914c5a-d401-4404-a263-83bb1d13e791",
"db_language_id": "4c3cc27b-50b8-4c8a-ab20-88c8f2934a8f",
"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-09-16T15:38:58.6440872+00:00"
},
"modified_dateutc": "2026-09-16T15:38:58.6440872+00:00"
},
"marketing_segment_id": "2c34a773-c0b1-4f8e-8d79-87ecb15644c9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d3f94976-3ea8-40f6-bc98-a26ac7544e6a",
"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": "5298b94a-2c58-473d-ba5b-c12c74363acf",
"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": "9c67aaa8-0bf7-4e63-a9d7-fcb163683f5f",
"db_country_code": "sample string 28",
"feelist_id": "6c022f08-ff37-4d26-b8f4-923bf4025d05",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "25732655-42d8-47d7-b98c-9a6232059b4d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6da0e3bb-caba-4844-80c8-936966ae3380",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T15:38:58.6440872+00:00",
"db_currency_id": "24aafecd-db62-4142-8da4-47d3072ec00d",
"db_currency_code": "sample string 10"
},
"company_type_id": "5f110d48-8701-40db-bf48-a27a842db300",
"company_type_name": "sample string 32",
"company_type": {
"id": "92d1fc89-3ad9-4621-b460-0b33c58e971a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9b4e83ae-1396-4fd2-bf03-618d85cfdf20",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5c242fb5-e742-4535-bb0e-ce74e02cc819",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "94f8804f-7d15-4443-97d3-ac4ec5988c91",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7ec89742-b05d-40ca-b389-4eb856446bf2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "515152fa-5e8b-4659-9df8-8b9c9b8defe1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-16T15:38:58.6440872+00:00"
},
"company_sector_id": "337f04f0-3901-4a64-b6e8-4e8f966a8f7e",
"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": "555e12c2-b5d7-4175-998b-8ef69c048fe2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "28cea922-7ae9-4737-a6b6-65f20e4f3ec8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "456272a3-f5c4-4978-b20d-a84bf76755f1",
"account_manager_user_code": "sample string 56",
"company_status_id": "c91ef6b3-1f5a-4540-a0d6-71f59ebe1df1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-16T15:38:58.6440872+00:00",
"id2": 60
},
"db_language_id": "f476a62b-b44d-452f-affd-0a5629829da5",
"db_language_code": "sample string 7",
"db_title_id": "a6087d63-a3e6-4949-9714-296bea9f7047",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-16T15:38:58.6440872+00:00",
"create_date": "2026-09-16T15:38:58.6440872+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-09-16T15:38:58.6440872+00:00"
}