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": "256d675a-52ac-492f-aa49-b5a026be40fb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7433fb8c-0370-4b81-9d1d-ce361ad69455",
"company_code": "sample string 5",
"company": {
"id": "655d55de-9345-4b4c-8b0f-f44bcb6e49e0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-30T23:19:52.1473929+00:00",
"sales_territory_id": "3ac303a2-acca-4332-955f-d98edd6935b9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "967fc506-1aa7-468a-81f6-2dfd82029035",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8ccadd60-7692-4d8a-80ab-4d592ef70656",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a322e60e-aef7-482f-b52d-cf4536cf3c9d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "162a207d-660f-45d3-8e90-4967cc2e9653",
"db_currency_id": "b5f27498-87ea-41f8-a7fd-f8c98c403504",
"db_language_id": "27d281d8-d603-4794-8bbb-e1a2f3aa580d",
"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-08-30T23:19:52.1473929+00:00"
},
"modified_dateutc": "2026-08-30T23:19:52.1473929+00:00"
},
"marketing_segment_id": "bc6cc8ad-f8a6-4b09-8762-9bea8ac05b59",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f8300f97-c69a-43b1-b1f4-60b0239936eb",
"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": "450a215d-d022-4d4f-b59b-07e2b0c60ac1",
"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": "1b3dd989-333d-48b8-81f1-ad5095462d66",
"db_country_code": "sample string 28",
"feelist_id": "b7ec3ec5-3eeb-40cc-a39a-61ee8832d8eb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e80e2e55-ac63-45de-a7e7-b3f227b4f6f4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "57f65079-2243-419e-9fbc-f1ae57171935",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-30T23:19:52.1473929+00:00",
"db_currency_id": "6d5b424e-11d5-4c11-818c-c31f77c4eda9",
"db_currency_code": "sample string 10"
},
"company_type_id": "f89dc39e-8263-4fb4-860f-021f3acaec58",
"company_type_name": "sample string 32",
"company_type": {
"id": "f8aa3d2e-5a01-44c5-a20e-3df87d892e47",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4be43ab9-59bc-48e1-99db-5f3205bd2a04",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ffa010c9-234b-49da-84b8-47c500a9d187",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6ec40f29-e905-444b-84d4-cb4456a18baa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0946b9a8-433a-4307-b2d5-51904c7d71b3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "22be4bd7-d760-4f09-9141-4a98321929a4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-30T23:19:52.1473929+00:00"
},
"company_sector_id": "bb7a8e5d-3b2c-4736-a6d8-3d37fdddba42",
"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": "34a7daa4-6854-410b-b6cd-619c48c004d6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3af1f04e-8053-46bf-ab78-5e64bdab2548",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5ae865d8-a328-45b0-885e-c49494e7dce2",
"account_manager_user_code": "sample string 56",
"company_status_id": "043a1ad6-4a52-4c6e-8d32-f89b9901aa7e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-30T23:19:52.1473929+00:00",
"id2": 60
},
"db_language_id": "04f353eb-97b8-4b1b-8e72-cb3e3787becd",
"db_language_code": "sample string 7",
"db_title_id": "5706d459-72cb-4f73-9d5d-5bb59d4e7577",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-30T23:19:52.1473929+00:00",
"create_date": "2026-08-30T23:19:52.1473929+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-08-30T23:19:52.1473929+00:00"
}