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": "1e269ea3-05b9-43e2-ba64-b69fa57ad147",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67ea0dad-9a98-4b08-9690-9942c6901d2c",
"company_code": "sample string 5",
"company": {
"id": "2ec53d82-66fd-434a-a1bd-0e1796799959",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-04T23:06:26.3380322+00:00",
"sales_territory_id": "132aab47-d952-4d7a-8f1f-3326b71b884e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9b581546-a618-407a-a409-6c7c802b4a6f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1bed844a-0cee-4705-9d2e-d2504ffd386f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "29957d2e-bef8-4879-b4f8-7d32c6353d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714675e6-5185-44b9-8ff9-84fc5d221f54",
"db_currency_id": "325beafe-e954-4384-b7f2-355886872578",
"db_language_id": "6018baa2-5bd8-4e9a-a482-a742e4ca79ff",
"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": "2025-11-04T23:06:26.3380322+00:00"
},
"modified_dateutc": "2025-11-04T23:06:26.3380322+00:00"
},
"marketing_segment_id": "12317c3f-b773-4e4c-85ee-804bfb2009e4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c47c1807-cfcb-495e-ae2d-2abf68d3870b",
"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": "fa5e43ee-e50f-41c6-b29f-ae7bee172e1e",
"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": "eee802cb-481c-4da3-9511-9828636f3706",
"db_country_code": "sample string 28",
"feelist_id": "7d5671ab-64fc-433e-9450-9b0e75a7ae31",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a6a91e1a-df31-466e-a35f-7ced1e053d12",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cf7de1b5-ea5a-4fc6-9e1d-7a0e72d78912",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-04T23:06:26.3380322+00:00",
"db_currency_id": "0e17cd75-5d3f-4477-807f-f4e80ae94f80",
"db_currency_code": "sample string 10"
},
"company_type_id": "c15e5875-2fbd-4567-b0cf-65509a977cf5",
"company_type_name": "sample string 32",
"company_type": {
"id": "e07873d6-ada3-4a0c-9fd4-a4852031fa3f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "acc83a62-6664-475f-afaa-18d0f0d83857",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2ac525f4-e5d3-4fa6-8788-544e6ba0206d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e9fab1d-4f2e-4bbb-b30f-d83706e6aafc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "43ba9aeb-e822-44e3-b666-938eb523e942",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ff1ff5d5-4d30-495e-9bc9-fbcf55def90d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-04T23:06:26.3380322+00:00"
},
"company_sector_id": "14d9ad05-1b09-4a20-a845-56d31285f837",
"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": "a9bab9f0-02e7-4f7a-b633-488201945329",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "686a1115-39d0-4047-81c2-8cf382df3788",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0f5a548-8398-4131-8d50-02fb1dc5ab81",
"account_manager_user_code": "sample string 56",
"company_status_id": "a885e862-4be4-4224-b64a-ae926813fd89",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-04T23:06:26.3380322+00:00",
"id2": 60
},
"db_language_id": "8f2e726c-17fb-4487-a86f-c20825f912eb",
"db_language_code": "sample string 7",
"db_title_id": "ffc57326-4cec-4537-81c2-fbc44623c35f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-04T23:06:26.3380322+00:00",
"create_date": "2025-11-04T23:06:26.3380322+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": "2025-11-04T23:06:26.3380322+00:00"
}