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": "b9fc99da-85e2-45b1-b67b-665a4ed824cd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b17b04fb-f438-4516-8341-1d8c45b49647",
"company_code": "sample string 5",
"company": {
"id": "8b1d31a1-8054-4976-99a9-e414bfd3258c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-24T10:17:32.6913651+00:00",
"sales_territory_id": "c3c1ccf2-016c-433a-9536-25c6632729a0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e6b47328-4cd9-41b8-8201-57b0d1e1a84d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1fa874ac-dc12-44de-8c01-616d48b3dd26",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c1397a0-038e-4195-87a2-10622530a858",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88e62a21-6e41-4b4d-bfa0-ca3772ba7fbe",
"db_currency_id": "f3fd7bb2-5913-40fe-b763-8ca52267dfcb",
"db_language_id": "3d21e3f1-d917-4699-a891-134f5173e0f0",
"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-24T10:17:32.6913651+00:00"
},
"modified_dateutc": "2026-01-24T10:17:32.6913651+00:00"
},
"marketing_segment_id": "5be614d8-0ee4-4189-8439-aaf8e211df7b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "617cecb4-68d4-4468-a95d-777a7e974f2a",
"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": "60ab8eee-eb3c-4751-974a-728863970bf1",
"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": "4295699c-2ff5-4924-972f-2752afed19f9",
"db_country_code": "sample string 28",
"feelist_id": "8c69032e-22e7-48f1-ae14-6a03734e5578",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "db64b278-8493-4ba0-b783-3c73e0264da0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6cea6bb8-c1f5-4abc-b0ac-f44f1b34a37f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-24T10:17:32.6913651+00:00",
"db_currency_id": "b9d280da-7392-4e4a-8478-0e9818ab41de",
"db_currency_code": "sample string 10"
},
"company_type_id": "c3b84326-5a12-4203-910c-8b6e87503f26",
"company_type_name": "sample string 32",
"company_type": {
"id": "0b97e045-3dc4-4712-bf73-f962c375f237",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1e2447bc-7e0d-49bc-9d6a-ca952a1f9c1b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "77a27340-80b2-4956-b308-c0f0562b427f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3d54b28d-562c-4229-bed3-5bfc2b8c8259",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ca033da0-37b1-46ba-9b14-5a1b3c3245ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "06480d14-c257-4f5d-a9da-5d147fd7e66f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-24T10:17:32.6913651+00:00"
},
"company_sector_id": "b2cd091d-f49c-4b6b-96ef-b05f58306ddb",
"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": "24784381-e2b6-494e-9dcf-32b641c7e351",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dc9c3ece-8d91-48c9-93de-b28b7728af38",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "87c06f02-d680-4598-aa68-b10b7fa503cc",
"account_manager_user_code": "sample string 56",
"company_status_id": "f5f40ad3-1a7a-4f3b-b00a-6ac2584ccec8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-24T10:17:32.6913651+00:00",
"id2": 60
},
"db_language_id": "ee7ae955-23d4-4dd0-9df1-0a080bd64bcf",
"db_language_code": "sample string 7",
"db_title_id": "4e6224d0-568b-4b48-b921-f79c7b0e9e0e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-24T10:17:32.6913651+00:00",
"create_date": "2026-01-24T10:17:32.6913651+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-24T10:17:32.6913651+00:00"
}