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": "731e2e5b-0ce5-4570-831e-ad5905528550",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5ae45def-9456-4560-bdad-75c92a9578dd",
"company_code": "sample string 5",
"company": {
"id": "4bb3fe27-3ac6-4ef9-a335-27bea9b76340",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-10T10:24:19.1361961+00:00",
"sales_territory_id": "5db10d8d-94f1-40e5-ac6f-3125393524a2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9d656a08-d70c-445c-8630-869a61146f81",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "20f529e4-edef-43da-86ec-751cdc187138",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cfd3536c-5480-4128-a6da-33c807dcda6d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f2860848-3f09-43c9-89de-dae334bf21d1",
"db_currency_id": "1eb08eac-0c02-4cc0-8aa7-cea3c50a123b",
"db_language_id": "43f22c43-ee2f-46d8-a500-71681a3f8f4b",
"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-10T10:24:19.1361961+00:00"
},
"modified_dateutc": "2026-09-10T10:24:19.1361961+00:00"
},
"marketing_segment_id": "343c7fd7-33fd-4147-a239-e80e5c142bc0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "62de1985-a861-47e0-89e0-d97f4d56f841",
"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": "8092b462-1202-4682-966e-2a093b448c74",
"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": "f4988b65-87d5-473d-8398-2dfbed9fc45c",
"db_country_code": "sample string 28",
"feelist_id": "083998f6-3616-4598-93f6-58c529a2d795",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e9075b6a-0857-4ace-a311-e9a1ab50f686",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b859d1f4-d2d0-43fc-9d7f-c79b68991f6b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-10T10:24:19.1361961+00:00",
"db_currency_id": "6ce06fd2-dcb4-494b-834b-a7c2ad070f65",
"db_currency_code": "sample string 10"
},
"company_type_id": "6765344d-b087-4019-ba0b-c8bc44d82e79",
"company_type_name": "sample string 32",
"company_type": {
"id": "d64a8926-d874-43ac-9c5e-4904cd03130d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b457af78-4da5-47bc-a8c8-3ca810dfb286",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4e0336a8-d0b2-4d02-a199-e4bf447f4323",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a732b130-0ce6-4219-9c1f-c4c70df70ba7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "77755a4b-ed14-492a-b7cf-dfefa5bf9cea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "580a67a2-5f34-42cd-8c69-590e476f75e9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-10T10:24:19.1361961+00:00"
},
"company_sector_id": "ff180289-1081-4bf2-a582-24168182adf3",
"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": "04e81bc6-823b-493f-8e77-3534a9afaca8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7329e86d-1839-40ee-ba97-d97a37f5b4c7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "de76747c-c6c4-4971-9cf3-6aff1f89a147",
"account_manager_user_code": "sample string 56",
"company_status_id": "33e2857e-edbe-40af-bd90-e54059d385be",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-10T10:24:19.1361961+00:00",
"id2": 60
},
"db_language_id": "19751b42-8ca5-4e07-a9ba-517e42b4927a",
"db_language_code": "sample string 7",
"db_title_id": "7e7c2f50-1b63-4b69-a7e7-f87a3d6c8784",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-10T10:24:19.1361961+00:00",
"create_date": "2026-09-10T10:24:19.1361961+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-10T10:24:19.1361961+00:00"
}