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
{
"id": "b50bb053-8848-4030-bd6e-e9d0b0c34159",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a0302eca-a984-4c3d-a2fd-dcdaa4fdb6e8",
"company_code": "sample string 5",
"company": {
"id": "f54c44ef-8f9a-41f0-9d9a-1dc45fbf9a0e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-20T20:46:48.2331562+00:00",
"sales_territory_id": "9833658e-c32f-4397-a753-70dec5fd2596",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0bdb13cb-5621-4d5f-b46f-86814a4e6ab1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "75b296f4-be8f-461f-91a4-3d0ace1fe0e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5f49a8ef-6c23-4245-baf7-0286aa263228",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d046ba03-998e-4973-8419-02a227e0ba0d",
"db_currency_id": "e43877e3-27d0-489b-a5dc-507e6b958ede",
"db_language_id": "d961ac60-34f2-4a34-bf09-07f0bb3c1c5f",
"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-20T20:46:48.2331562+00:00"
},
"modified_dateutc": "2026-11-20T20:46:48.2331562+00:00"
},
"marketing_segment_id": "caa561b6-3263-49d9-a197-7b2ba5e90fd7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d266544a-6ae8-49ac-8f7f-75f64f99f3a3",
"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": "8e34d6bf-402e-4293-acff-02b8b683f94b",
"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": "e8b8f5f2-0c47-4133-8a07-fa1ac0d4185c",
"db_country_code": "sample string 28",
"feelist_id": "2eba77fb-157a-4bb0-9d8e-434d7b2379ba",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8101d1f4-d44c-41d5-9b07-36486bb5ea3b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d486e26a-aa54-4e52-902f-e72f03aa40f7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-20T20:46:48.2331562+00:00",
"db_currency_id": "8568e87b-2248-45e1-adab-97f06ba23077",
"db_currency_code": "sample string 10"
},
"company_type_id": "ac94c62b-46b4-420c-b0af-2aa04ae7a83a",
"company_type_name": "sample string 32",
"company_type": {
"id": "483bcac8-9eeb-4608-8395-cc4d5ec0cde5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1cc56788-1145-4e8a-8028-e92ed9440314",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7f0b2efc-23ad-47d8-a0b4-94d044df3c12",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0bda9fd1-7a3b-465d-8021-aa320c2b01d0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e64f3974-eef2-4476-b237-e7a99ae98f82",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bcb47a0c-76e2-4371-9445-2f30fbdf27cb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-20T20:46:48.2331562+00:00"
},
"company_sector_id": "af3a4a89-2980-4960-8b12-dcc1226df1d8",
"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": "422425c9-49b4-4e30-9ea3-1ae6ccb761a5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b244e260-d6c9-4ab2-b671-3be05c760959",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c51019b8-b38a-4c5c-abdc-df2218e72258",
"account_manager_user_code": "sample string 56",
"company_status_id": "57f6af78-b37f-4ec1-b42d-47d610d044fd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-20T20:46:48.2331562+00:00",
"id2": 60
},
"db_language_id": "4904844e-8166-4a6f-afff-e5fb6b2b2c4f",
"db_language_code": "sample string 7",
"db_title_id": "a8714315-e579-4797-b89b-f79992f20f48",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-20T20:46:48.2331562+00:00",
"create_date": "2026-11-20T20:46:48.2331562+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-20T20:46:48.2331562+00:00"
}