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": "cb0d0fee-1d82-4336-962b-da77fafe4ba6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d0daeaf6-cea6-448e-9f22-085b0dfed41a",
"company_code": "sample string 5",
"company": {
"id": "3d7ce034-ecc8-43fa-9f04-c095afde5e9e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-03T00:30:41.4652076+00:00",
"sales_territory_id": "c668b5ad-3128-44e7-b77d-9e4530aed692",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "079c9d1f-f49a-4121-9c3d-7125e435bda5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bb50c567-1010-4548-ac25-ccdb7b8a1c02",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c43d6e9-2b44-45ef-9003-7bbbe6b2574b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed07b691-4d40-4ac7-a171-98f2231b6877",
"db_currency_id": "ced0d08f-3ebb-451d-9d8d-55b90edb1193",
"db_language_id": "934651b1-bb8f-444b-8ef1-f119a9c69b51",
"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-03T00:30:41.4652076+00:00"
},
"modified_dateutc": "2025-12-03T00:30:41.4652076+00:00"
},
"marketing_segment_id": "ce76ad85-2d03-48c7-9a33-2c1aa217d298",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6df11ddb-174b-4765-af5b-55ced192e7be",
"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": "1ebaaab5-05c7-4759-858b-ea71a9b7a7c1",
"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": "9c04c2c1-0ef8-45cf-98c5-ae58a4d45749",
"db_country_code": "sample string 28",
"feelist_id": "ba814eee-4d03-4efb-959e-c1a2c1cf5ca2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1e4963c2-301c-4bad-9600-921e0d8b9b8d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "67a02e1f-e6f4-43cc-863e-c7bc398d5509",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-03T00:30:41.4652076+00:00",
"db_currency_id": "f1c88e7a-4c70-440d-a5e2-5f59d6740a26",
"db_currency_code": "sample string 10"
},
"company_type_id": "e30beded-8187-4913-ba8e-5688693b94a7",
"company_type_name": "sample string 32",
"company_type": {
"id": "b24daed3-32c5-4cff-89b9-fb8edaf9d1b4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8870c602-b146-4201-b5dd-31904bbeb0aa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d17cc3e5-a044-449d-81e3-fe029515550c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5dac7752-ec5d-4e41-97a1-47d4d0d0ae66",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f6602dd1-37b6-42d4-8562-99b942d7d32f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bf8c8305-0350-4a1f-9564-c22c9d26f68d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-03T00:30:41.4652076+00:00"
},
"company_sector_id": "4bf7de67-804c-4851-97fd-8d457d931d2c",
"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": "930095e5-2aa6-4153-9e1c-d7566cd50f6c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e7d23b32-481d-4169-aef8-e370c85fe9f4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "397cc37d-7d1c-4ac9-ade9-4cdc28120ea9",
"account_manager_user_code": "sample string 56",
"company_status_id": "71831d09-b4a6-48fc-a602-a7a5816e1a51",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-03T00:30:41.4652076+00:00",
"id2": 60
},
"db_language_id": "0d3bc07e-8ddc-41e2-a918-ea3b90b13e2d",
"db_language_code": "sample string 7",
"db_title_id": "404f3fad-3691-4400-b365-bdb9123b5569",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-03T00:30:41.4652076+00:00",
"create_date": "2025-12-03T00:30:41.4652076+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-03T00:30:41.4652076+00:00"
}