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": "974acb65-72e0-4b2b-9df2-9061c2da3731",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8e6d84b4-05cd-4ca1-86d5-5f7f7da4df95",
"company_code": "sample string 5",
"company": {
"id": "45bc2155-6537-49bc-a874-5dbfe228797d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-12T17:12:44.8828252+00:00",
"sales_territory_id": "4de114a6-f814-4ad0-b649-56741473689e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9fb9022b-7890-4a8e-8ac1-df370a33834f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f0d11b34-e0fd-473e-9f41-d8f5b02afe44",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ad54867a-d90f-4c4f-9820-e400300ffb0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2eb8a979-f885-487f-853c-57136206059b",
"db_currency_id": "f1e6524a-801c-4b70-b7a8-3dc275731c03",
"db_language_id": "03575791-7b0c-4ff9-b235-9010a7626437",
"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-12T17:12:44.8828252+00:00"
},
"modified_dateutc": "2026-01-12T17:12:44.8828252+00:00"
},
"marketing_segment_id": "eb017c35-056f-401f-9609-85e86f3c10eb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4324a4f3-06ff-4614-b766-d7eb71541d17",
"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": "d7a8fa0b-c4e0-41b7-82d1-7f9e8a374480",
"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": "8472d348-3790-480e-9371-b84d44556ca4",
"db_country_code": "sample string 28",
"feelist_id": "f2749b1b-bfd2-4e25-b54f-c62ce89b648b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1476106c-9093-4ab6-a57c-1cd7459856a2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e045b0b0-98a8-4ec3-af20-edf1b4e57684",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-12T17:12:44.8828252+00:00",
"db_currency_id": "02437adf-c30c-43bc-8761-a78139661042",
"db_currency_code": "sample string 10"
},
"company_type_id": "8a130dbd-ef28-4ae5-a867-d1782a5fb76e",
"company_type_name": "sample string 32",
"company_type": {
"id": "b26b8b53-b9ac-40a5-9426-735e879ab302",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6d8a9e67-0be1-4ee2-9171-990cace658b5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f65fdf39-a550-4803-8579-68a9e7c8bc61",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "64e2f9ba-b891-4f26-81b8-d534f7f79f37",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4fd51b2d-179b-4572-9056-6fde0f52f2d3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0840ecc7-bc78-45a6-8cc0-954aad6248db",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-12T17:12:44.8828252+00:00"
},
"company_sector_id": "d5aade35-29db-4d02-ba28-4400165126f5",
"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": "d72a4148-0809-4547-9bfa-93282bcf3d0e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "07f7f6ca-2f1d-4bf4-a23c-33f2c16b5adf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4ce6bf76-bccc-4109-8dc8-964639869ed0",
"account_manager_user_code": "sample string 56",
"company_status_id": "87447ac4-5070-46c3-990a-1cd1f5787724",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-12T17:12:44.8828252+00:00",
"id2": 60
},
"db_language_id": "59c764fa-1cdb-4207-866a-ca8511ee3dbc",
"db_language_code": "sample string 7",
"db_title_id": "dc5ec103-fb75-44f2-86fa-3fd5e612bf67",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-12T17:12:44.8828252+00:00",
"create_date": "2026-01-12T17:12:44.8828252+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-12T17:12:44.8828252+00:00"
}