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": "8c136dde-93e5-411b-a66a-745f8d316be0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "532f9cb5-8fed-4199-8f07-b1521579a4a4",
"company_code": "sample string 5",
"company": {
"id": "802e19fe-6dc5-40b0-9fd7-768cb1dcedac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-12T14:55:20.4180975+00:00",
"sales_territory_id": "c310e403-9cc2-4280-a274-d4975d4f632a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5e37b5e3-2459-467a-909a-72203f7d4b13",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "da2764c4-70bd-4570-805a-6b03151243a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70e60694-155b-4382-85e9-1a890d744821",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35f5966a-8015-46db-8275-1d4f90ef3abf",
"db_currency_id": "9fe314ba-1e6a-44f9-8afb-ad7d962e18e3",
"db_language_id": "5b5d6cd0-2b39-4826-b677-7472fdf886a7",
"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-11-12T14:55:20.4180975+00:00"
},
"modified_dateutc": "2026-11-12T14:55:20.4180975+00:00"
},
"marketing_segment_id": "17410bf5-52ba-4164-a849-07f139594616",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cc82a9a0-6126-48fb-9278-88612d087982",
"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": "569c7e45-5fe1-4e86-bd9d-fc6168efdb00",
"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": "29525f57-91b3-4f42-9758-a68f23dd4f5c",
"db_country_code": "sample string 28",
"feelist_id": "a9b60736-ec2d-4688-90c9-efff97b09de3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a7ca8ab2-8335-45b3-a8db-64bb9977cc9e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "837cd6dd-5ebb-4ccf-a16f-5f6600c6e34b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-12T14:55:20.4180975+00:00",
"db_currency_id": "ec2ffa94-8ee7-4e68-b36a-14f9e8c884a8",
"db_currency_code": "sample string 10"
},
"company_type_id": "b29e20df-b2cc-4da7-ad54-268620fb9968",
"company_type_name": "sample string 32",
"company_type": {
"id": "c7550a4b-9509-4730-ad0e-1f33877e3aee",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb32912e-e922-480e-8c5f-487bd7f1295e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1d9ad260-b430-4548-bc72-5f566cdb3332",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "63f74e7f-42ed-4790-9d66-f782eb0a309b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1ba3098e-023d-47cf-bfd6-3ae25b807fae",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bf6e154c-be3e-47bf-b05d-658f1ac42d65",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-12T14:55:20.4180975+00:00"
},
"company_sector_id": "26e4cba5-2e3a-49ef-96b6-17d84234680a",
"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": "e3e283be-eb94-4e0f-844e-b6ff82926527",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5fa3658a-7f06-4ce4-b59f-b5accfbdfa90",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1cec9f7e-8922-4bc5-baa1-39b0082829a6",
"account_manager_user_code": "sample string 56",
"company_status_id": "5f426a2c-9581-450e-beea-8d75ab45b062",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-12T14:55:20.433931+00:00",
"id2": 60
},
"db_language_id": "c60308da-bb8a-413b-8f98-1faa9e41c093",
"db_language_code": "sample string 7",
"db_title_id": "fa75463e-c840-4f58-a34f-00899d494ba4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-12T14:55:20.433931+00:00",
"create_date": "2026-11-12T14:55:20.433931+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-11-12T14:55:20.433931+00:00"
}