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": "cbb8d16b-e702-462d-86b4-a353033e72af",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c06843cb-ff0e-4ea7-afb5-3ab3488ee9f8",
"company_code": "sample string 5",
"company": {
"id": "d0609881-823a-4d33-9650-f96680842983",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-22T17:39:18.8384014+00:00",
"sales_territory_id": "79ca0817-8140-4cb8-b08a-4c3ccc99685e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2bb22f8f-b48f-457e-b356-e51c9bcf1516",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "79c5cee0-e4cf-4568-a220-0af313f58f6a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "94aed002-b149-4504-91c9-e7be3ab750f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4080d0c-61ee-4cf9-8dda-b6add0a19e9b",
"db_currency_id": "4ce385e6-a6df-43f0-b360-f14e7d69e3bc",
"db_language_id": "55b42f39-01a4-40b8-a6b0-99b335807db3",
"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-05-22T17:39:18.8384014+00:00"
},
"modified_dateutc": "2026-05-22T17:39:18.8384014+00:00"
},
"marketing_segment_id": "8974f588-179e-42eb-ba52-b67c289b1c61",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "715a089e-bf0e-40ff-9b75-a88ade9ae834",
"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": "00783901-0e9b-4eb6-aeba-d1843e75a5e7",
"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": "47ab6b6d-c5e2-4d75-ad3d-d3c3693527fe",
"db_country_code": "sample string 28",
"feelist_id": "07d502c8-9b89-4ec8-8880-f3cfe08ee8a4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4a2e9a4b-8708-4d30-a87b-1f904c28c23a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a1acce18-c607-4962-b2d3-d77f21e3c366",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-22T17:39:18.8384014+00:00",
"db_currency_id": "5ec3d9b2-05a2-4e46-a26f-79da68c5f52a",
"db_currency_code": "sample string 10"
},
"company_type_id": "13591c62-6d21-4d04-bc51-185e03798ef6",
"company_type_name": "sample string 32",
"company_type": {
"id": "b94e5148-5db7-41c2-a3d6-ed41c36a3b30",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d80595bd-9587-491c-bc1b-c1b666c3b691",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cc91e512-5a35-4ab5-be58-95328e0309ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "05a0e800-7eb8-4720-8da6-4506854aa2d0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3ebabb8f-405a-4550-8872-a4a866dccadd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fcaabca9-10e3-4b2d-b619-f88a5fa4d034",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-22T17:39:18.8384014+00:00"
},
"company_sector_id": "d95d39dc-f147-4f73-b1de-6cab79ad4d77",
"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": "f9bf8d3e-8eee-4178-8306-b6a714aa1034",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "20a6e8d6-745d-4f5f-9a1b-c56f32cc1f1d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e061f6ac-bea3-4474-82c6-d99212501d24",
"account_manager_user_code": "sample string 56",
"company_status_id": "d4ebd509-29f5-4d8f-9208-80c18ded4498",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-22T17:39:18.8384014+00:00",
"id2": 60
},
"db_language_id": "e6cfba62-9ee8-4f92-85f3-9e822b4852f8",
"db_language_code": "sample string 7",
"db_title_id": "52047019-bbd5-45be-95d7-6caad5c9347c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-22T17:39:18.8384014+00:00",
"create_date": "2026-05-22T17:39:18.8540238+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-05-22T17:39:18.8540238+00:00"
}