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": "6fa0533e-7649-47d7-afe1-9553b852efdd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c072d8aa-62b8-4928-9cba-58fe43f8d636",
"company_code": "sample string 5",
"company": {
"id": "ed626ecf-53bc-41b6-8bc1-e0b026a5284d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-08T18:08:58.6829608+00:00",
"sales_territory_id": "7fe2e0a7-6f96-403f-9f4f-f45ba484ff08",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f2432a62-0d96-4632-9d6a-2f6028c1a4a8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "62e3f89a-4b2b-4336-a7a9-2c112f643424",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "95a70e84-854d-4594-a255-9d04b1eb7bf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d59b2e92-b653-4838-b12c-88f3606bf318",
"db_currency_id": "defa2c9d-44b6-468e-bcf2-97c1e60c8f58",
"db_language_id": "07296619-358c-40a2-bd65-b9292ca47671",
"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-08-08T18:08:58.6829608+00:00"
},
"modified_dateutc": "2026-08-08T18:08:58.6829608+00:00"
},
"marketing_segment_id": "acc888e2-6f19-4820-b159-dd2f946b3512",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c394c1d3-0196-4c46-8942-84c95818e8bf",
"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": "4aa89e42-e1c3-4026-a542-35e753d716df",
"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": "3f13486c-d244-4132-a3cc-5de81c46bcc2",
"db_country_code": "sample string 28",
"feelist_id": "727dc33e-a723-4530-ab71-ba8ac4983bdd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f9b689cb-5915-4097-94d1-da0d848885a7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7c52f6e6-e07f-4db2-bb94-9dd93ad6fd8c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-08T18:08:58.6829608+00:00",
"db_currency_id": "5779c9a1-d856-4fc1-a4c5-7b5c94548872",
"db_currency_code": "sample string 10"
},
"company_type_id": "44685316-bcdc-4dcd-990d-99fb059e0c1a",
"company_type_name": "sample string 32",
"company_type": {
"id": "121bff1f-db28-4cdc-9838-f15c8b4e21c6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "328cf322-7db1-4ca9-8794-8094a8ad71cc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2ed6a0ab-cc74-4d77-9d9a-a465385731f2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fa1abb8d-4c56-45a4-bce8-1c5d36889364",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "317433fc-5d47-4b19-98cb-30db08a92719",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9fc470b9-a933-4239-b9fb-f5c1de40f4cc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-08T18:08:58.6829608+00:00"
},
"company_sector_id": "9df750f8-0d1e-48ed-9466-8148c50f3f82",
"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": "fe40626f-55de-4154-acde-9d489956dc9a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9262c66e-a863-42e1-9925-a3dd0bd3e6ed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d39a655f-ef65-4667-8322-64f29573adf4",
"account_manager_user_code": "sample string 56",
"company_status_id": "ffa2cd36-a18f-48e0-a141-544ea3e62680",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-08T18:08:58.6829608+00:00",
"id2": 60
},
"db_language_id": "65e07be1-748a-47e1-a223-48e024fac007",
"db_language_code": "sample string 7",
"db_title_id": "c4e60a2d-b9c4-4ca5-a4f0-6fcfdbb45313",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-08T18:08:58.6829608+00:00",
"create_date": "2026-08-08T18:08:58.6829608+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-08-08T18:08:58.6829608+00:00"
}