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": "be2c989d-18f2-437b-87cd-bd12f376ed4f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e7c5fe3c-6c5c-4662-ae39-2530ae85c54b",
"company_code": "sample string 5",
"company": {
"id": "df85409c-ea34-44a4-9c0b-d71bc62c1a6c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-28T19:43:05.4059583+00:00",
"sales_territory_id": "33310b6c-5d91-4493-b1c7-c4474c1f66a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "af60cc4f-f1c8-42f2-88d0-fb49c3b86c28",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c116e0e2-ddba-4c0c-a986-7b9a26ce2e54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8127213c-7d87-4bad-a795-299d28da8f31",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a3d38d-1a8d-4b25-a36d-8bd3ed1f4260",
"db_currency_id": "afce90e6-141e-49ed-90ac-3409871bdf44",
"db_language_id": "adde8678-ac30-4b53-92a6-ff75616da320",
"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-07-28T19:43:05.4059583+00:00"
},
"modified_dateutc": "2026-07-28T19:43:05.4059583+00:00"
},
"marketing_segment_id": "3d5ffe91-4efe-45a3-b7ab-3edea1f25197",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b7251f6-efee-486c-839e-1e0ff6dfcf84",
"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": "af8be95c-2866-4b42-89d1-2a6c368c098d",
"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": "886cf5d5-36b1-4455-be42-b164a961c771",
"db_country_code": "sample string 28",
"feelist_id": "8f6e64f0-bb6e-423d-b641-9574e980e76a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dfc97001-cbf0-4e4f-8b86-551b13f03c6d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a98857a7-d5a0-46a7-bd96-c1047e7e0895",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-28T19:43:05.4059583+00:00",
"db_currency_id": "da37e649-8cca-4b94-8880-a930fe3250b2",
"db_currency_code": "sample string 10"
},
"company_type_id": "3d51cd66-5b7b-4bd3-a74a-86c33cfbfb6f",
"company_type_name": "sample string 32",
"company_type": {
"id": "eb6ead52-e5c7-4798-a1e6-b69dcc816dd5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cd72b8c1-b4bc-4730-94f3-401c20c1f903",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b5cca0bd-5987-49eb-9a0f-a4c730c9dc4d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "68c825b9-c757-4ec8-93a0-d80c5049481d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "37722f88-2351-4d30-ad7f-0bde90b4c7c9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "59b9382b-eed1-4965-b6b2-4360212378b3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-28T19:43:05.4059583+00:00"
},
"company_sector_id": "a43b7a4a-6189-40fe-8ba6-b656a146958a",
"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": "ec79cb6d-27b9-44b0-9718-b684f44cacb2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b41a92ae-8316-4d89-836a-ca26bac3a85c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ab7aca00-7ac7-4e5e-9b56-867e81138001",
"account_manager_user_code": "sample string 56",
"company_status_id": "52e1a53a-4477-4e5c-8eff-a066c386810a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-28T19:43:05.4059583+00:00",
"id2": 60
},
"db_language_id": "6e8e7b4d-450c-4538-aaf9-2c10d715cefa",
"db_language_code": "sample string 7",
"db_title_id": "40f2a053-a921-4d3f-b5bd-fd7d0a70d2d7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-28T19:43:05.4059583+00:00",
"create_date": "2026-07-28T19:43:05.4059583+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-07-28T19:43:05.4059583+00:00"
}