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": "1151c6a6-8517-448c-a364-5fdb85fe2462",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0167419c-87a6-4d4e-84cc-96b4ee56ca53",
"company_code": "sample string 5",
"company": {
"id": "f66b262e-d2d9-40ed-935c-8c2159c4d50b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-14T06:24:48.2731771+00:00",
"sales_territory_id": "0c51cd57-f9ef-48c8-b463-16d2d40a5214",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "47aa52d0-bfd7-417a-ac09-1b3246043a8a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c9711599-565d-484f-9b71-8c807c9b99a1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6b886a36-c549-42e8-a944-79a2c8dadcb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "847041ee-4cde-4c01-bfae-41cbf77aa504",
"db_currency_id": "d791a0f7-3fc4-4b2f-8342-53e300d732c9",
"db_language_id": "37931984-87f8-4720-b12d-0d00b0c96033",
"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-06-14T06:24:48.2731771+00:00"
},
"modified_dateutc": "2026-06-14T06:24:48.2731771+00:00"
},
"marketing_segment_id": "50bca3a2-f807-4fc4-b40f-05c7b4a0ab29",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e4b0beb7-9211-4d4b-8252-a81ac4503d5c",
"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": "10758b5c-5a13-4331-b6ef-3079335c28ba",
"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": "58f989c1-c689-448e-914a-0b686e21fb9e",
"db_country_code": "sample string 28",
"feelist_id": "540c4b35-8d14-477e-a189-251d7d8f5c90",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "640c864c-676a-4100-bf53-6fa4de725323",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0516b450-3b74-4088-a4aa-1093562543e4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-14T06:24:48.3044285+00:00",
"db_currency_id": "c9e73396-620e-4656-876f-260c2bb6e5f6",
"db_currency_code": "sample string 10"
},
"company_type_id": "46c332a8-0236-45eb-aef8-a17eeace82fe",
"company_type_name": "sample string 32",
"company_type": {
"id": "83ee0b6c-b4ef-49ed-bc7c-4a70bcf9765a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c3a6d423-116c-412c-a5c7-096c3ba3b3a0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f2ebcde6-db2b-46e9-bcd9-5da2a56fa943",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8d78a242-192c-4343-8649-3c8c6664424f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dc92dd2e-1bbc-49fb-843c-756a821e3572",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1272a29f-7dd0-497a-a246-71259eacae1a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-14T06:24:48.3044285+00:00"
},
"company_sector_id": "8f31bd1d-ef10-49e3-bca3-91ab12d050fa",
"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": "45ec2c43-d46d-4ad1-a71a-1cf4a59958e8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cb66e9dd-b991-4b6d-a529-d36a14f53be2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "56486547-cdb3-41f6-9a64-42205a448dd8",
"account_manager_user_code": "sample string 56",
"company_status_id": "3547111d-9c5d-476f-892a-bc018246f83c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-14T06:24:48.3044285+00:00",
"id2": 60
},
"db_language_id": "6170a9f6-f586-40c5-85d3-359c3b3eaee8",
"db_language_code": "sample string 7",
"db_title_id": "5b4d7aee-8591-45bd-b70d-b9a0b9c9c359",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-14T06:24:48.3044285+00:00",
"create_date": "2026-06-14T06:24:48.3044285+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-06-14T06:24:48.3044285+00:00"
}