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": "c42b6a5e-bf7a-47e2-afc5-88683a28eea3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8a9bb88e-8663-45bb-9422-2beb7b686ada",
"company_code": "sample string 5",
"company": {
"id": "db5f28c1-a947-4be7-86d6-0a973758e5c1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-11T21:55:22.2197773+00:00",
"sales_territory_id": "ede75712-32bb-4578-a7df-b03f23108739",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cece98fa-53dc-4167-9a1b-df0d29b9d8c1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "757edf5f-9539-4d6d-83d1-4d700880e139",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "93e10776-4a89-4018-8be2-7e284db50b37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c84878b-1ba1-4605-bf4e-b8291d46702a",
"db_currency_id": "779ca610-389d-43af-8d3e-a80775515714",
"db_language_id": "1e06cfe7-aa7e-443e-82a3-d2f157206e9d",
"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-11T21:55:22.2197773+00:00"
},
"modified_dateutc": "2026-11-11T21:55:22.2197773+00:00"
},
"marketing_segment_id": "c51cbcd6-cf69-48a4-8e3e-02c2996b64b5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a6d7b6b3-712c-453f-bb29-2f33e8e04bfd",
"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": "892d5b28-c4a6-411a-b86e-faac532c0e98",
"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": "a3d2a908-72b1-404e-9115-be1dfb404ee2",
"db_country_code": "sample string 28",
"feelist_id": "68b31349-a3b4-4fdf-b1e1-cea343165a56",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0b0cb06a-3cf7-4cc3-9b6d-e6cc690c6d79",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f1ac9cca-5a74-40d9-8828-d9b3ea486c8c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-11T21:55:22.2197773+00:00",
"db_currency_id": "1575f6ca-2c8d-4d61-9713-1b29b7ef5a75",
"db_currency_code": "sample string 10"
},
"company_type_id": "6bae86de-6835-4f1d-84c1-5f180b7e8a02",
"company_type_name": "sample string 32",
"company_type": {
"id": "48905635-44ef-415d-b150-2da74c54ca93",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "29a79549-eea1-458e-877f-a0406dc90a6c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "07c9109e-304d-4b91-a6e7-c718c10e6f90",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d48d80de-d00d-4a71-b829-76c10780d279",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "48015075-3c6e-4bc2-85c2-b19862b310a4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f2f93575-c7fb-4686-8a44-89ac1d01ee60",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-11T21:55:22.2197773+00:00"
},
"company_sector_id": "2b69c0ae-144d-4bd9-8623-8031826b041e",
"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": "600fb43b-eff7-41cd-a4cc-1ef0a19be7ea",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "82a5ad8b-ca04-469d-b329-9fa882d6d875",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9b8c543b-780a-4e60-af89-9c933938a68c",
"account_manager_user_code": "sample string 56",
"company_status_id": "5f0926b2-a2e6-48a5-93ec-41d8a60834ff",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-11T21:55:22.2197773+00:00",
"id2": 60
},
"db_language_id": "03104b20-3da1-462a-9ca6-cbb2bba0a132",
"db_language_code": "sample string 7",
"db_title_id": "66262c4b-5ce5-4958-92aa-cd283428ad3d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-11T21:55:22.2197773+00:00",
"create_date": "2026-11-11T21:55:22.2197773+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-11T21:55:22.2197773+00:00"
}