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": "7f84b0db-519f-40fb-8f2b-68cb6f999317",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f53671db-e5b1-4a7e-99f3-329032f1ca00",
"company_code": "sample string 5",
"company": {
"id": "73e680d3-cf49-4c13-a077-8fb7be324517",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:43:59.6793722+00:00",
"sales_territory_id": "6f63964b-65dd-4b31-aec0-9feea9eac4a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "671dfbcf-b34d-47bd-a8b1-19a8c480787a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a837324-a122-4796-82ea-9c6f842ecf9b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ef7c236-b7bb-4106-acf7-5ae5471c9d31",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdafaaa5-8ffb-4ad7-b08f-41c02abc5201",
"db_currency_id": "dbfc1024-9ca9-4154-87c0-dc18bc6f8752",
"db_language_id": "ffc67f23-67cc-4520-8c24-01252c63ce92",
"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-08-12T12:43:59.6793722+00:00"
},
"modified_dateutc": "2025-08-12T12:43:59.6793722+00:00"
},
"marketing_segment_id": "1229faa2-b368-4fd8-917c-c405d3c18f15",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e3f890bc-668b-4950-b424-561e451bb51c",
"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": "66b3ba3e-2b4f-4603-a914-9c810aca6eb6",
"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": "a196188b-614a-473d-ab77-42e8dbbc8bba",
"db_country_code": "sample string 28",
"feelist_id": "f7bf95c7-481d-4e05-af0d-75432e4bc39e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b24d8714-1657-4122-99b0-fab888b00bb3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "51564e4d-36bc-43f2-8fe0-1150b7a7dcb0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:43:59.6793722+00:00",
"db_currency_id": "a0051996-7e7f-4d50-84b9-dbfb9549e014",
"db_currency_code": "sample string 10"
},
"company_type_id": "378289c1-d2bf-45c1-bcab-20824fc43dc8",
"company_type_name": "sample string 32",
"company_type": {
"id": "6553d91e-7281-42a8-8f24-fc9b3181971a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4eaabc0-b0ae-44cd-af01-d81e86bbd957",
"sales_organization_code": "sample string 5"
},
"db_language_id": "756ce0af-ee81-4162-9e8b-c90e891a1df7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8bcd199a-abac-46cf-a2f6-faf41cbf004f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c43f6419-e7b6-42e8-9485-723f2370949f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "808ac529-2381-49ea-94f1-060712b92754",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:43:59.6793722+00:00"
},
"company_sector_id": "0aca986e-9beb-4b0e-bbe9-6d8f4e5a7113",
"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": "edc68f45-6eff-4c70-9a4b-7cce7d228830",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5a047c04-9df9-4eba-a607-4f661d6ceead",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c3b0dc10-6468-45af-8ddb-fa09e5c774f2",
"account_manager_user_code": "sample string 56",
"company_status_id": "a61c1dde-1688-4c0b-97cb-484cf84a3f85",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:43:59.6793722+00:00",
"id2": 60
},
"db_language_id": "c8d6ec06-359e-4683-9856-b6c7fb836a87",
"db_language_code": "sample string 7",
"db_title_id": "2ec1d9bd-28ee-4fab-8370-01adfd0e3da8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:43:59.6793722+00:00",
"create_date": "2025-08-12T12:43:59.6793722+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-08-12T12:43:59.6793722+00:00"
}