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": "4b1a70f6-f98b-488c-a01e-feaef09c6b13",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "777184b3-c8f6-48db-a705-cb8a60a369c5",
"company_code": "sample string 5",
"company": {
"id": "624a44b6-7985-465d-938c-e777583a03de",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-11T13:28:21.1212795+00:00",
"sales_territory_id": "ca33f950-1fe1-4ed3-98f5-3458f7fedf1b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "59340c01-e0a2-418e-aae9-0c24adde0017",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7b18e30-33d5-4a2a-9b92-d3d3c16f7cdd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bdf9ff38-9276-4430-bfe8-8a2836ced2b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c4b2273-7e98-4f49-99f4-6500d57192ab",
"db_currency_id": "0af2199f-d7f8-40b7-8575-43ae46df1efd",
"db_language_id": "cee5ff7d-ca28-4175-a100-2950eea546d7",
"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-10-11T13:28:21.1212795+00:00"
},
"modified_dateutc": "2026-10-11T13:28:21.1212795+00:00"
},
"marketing_segment_id": "99be8c1a-f5e4-4e46-a22c-8b1b183a9b12",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b44b483c-5afd-4527-8578-acfb01de2e67",
"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": "6f8bee51-53f1-4081-b8af-7a135cda9de5",
"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": "792a83ca-6051-4291-b3c7-9674acb5fdc2",
"db_country_code": "sample string 28",
"feelist_id": "63495085-511f-46a1-bdc1-8ecde4e2b071",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1592f053-c919-409b-840f-fc5efcf35574",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0eef34c8-0ccf-417d-a8dd-24423a261761",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-11T13:28:21.1212795+00:00",
"db_currency_id": "d919e8cb-2291-42e3-8c6e-3c1d5ee2a3c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "3f815dfe-bbbf-4d66-892d-af1d69f0c895",
"company_type_name": "sample string 32",
"company_type": {
"id": "ff4c864b-4d4d-49f9-b386-8667ef9a60ae",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b05075c-c529-482b-a5ba-228e0bae292a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5a23a445-d33c-4399-a744-87978a9fbb63",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fe903426-21dd-4ab0-8651-8974a4adbd99",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9ea5d8f7-12bf-476c-8a07-781383e14cfa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bea4422d-df4a-4d50-8676-cc275fba661a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-11T13:28:21.1317519+00:00"
},
"company_sector_id": "301bad26-e675-495a-80e7-474b6aea75de",
"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": "0b8de360-ed10-42ca-8572-5856a0e0b172",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d56de284-d552-4330-bd31-f16773154621",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0ad31d76-43e3-4e98-bed6-4b2af2999b81",
"account_manager_user_code": "sample string 56",
"company_status_id": "249595c9-60ec-45d8-8a05-e361cf492a2d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-11T13:28:21.1317519+00:00",
"id2": 60
},
"db_language_id": "7b1cf653-000e-44cf-bd8a-f78c59336a5d",
"db_language_code": "sample string 7",
"db_title_id": "2264f06a-2363-4dc2-8a59-4b8d5393dbe2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-11T13:28:21.1317519+00:00",
"create_date": "2026-10-11T13:28:21.1317519+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-10-11T13:28:21.1317519+00:00"
}