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": "84fe6c9e-b0f4-48b5-a08e-a0a9e65903eb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0c363581-fd6d-418b-abb3-963fb1024e5f",
"company_code": "sample string 5",
"company": {
"id": "9036bb48-ff94-4339-9f8a-ea66fd74c596",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-25T22:00:55.0132799+00:00",
"sales_territory_id": "70fc13e1-0ebc-4710-a3b1-638488dd9b01",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "729f5410-6d3c-4565-b47b-6fafd9ad8327",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dcd07158-0779-4181-9eec-732a652bd426",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "737cc1c3-8d0e-4a9b-806c-ac533cd6afdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4118320c-72a1-45f5-af03-194c7a7eabe2",
"db_currency_id": "da91e0dc-7cde-46ab-a5c0-4bd5f625eb9d",
"db_language_id": "85f9e66f-dc5e-4066-96e1-622f806b8ca9",
"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-25T22:00:55.0132799+00:00"
},
"modified_dateutc": "2025-11-25T22:00:55.0132799+00:00"
},
"marketing_segment_id": "e11a3067-e42a-41c2-87b7-6f6a6807e67e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "995ff501-8556-4fcc-ac33-356ee288ed49",
"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": "9d6575b7-41ee-409e-834d-1e89f22a5a53",
"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": "45693201-4f95-4469-899d-9032c7b5da46",
"db_country_code": "sample string 28",
"feelist_id": "7316fe45-49cb-4f73-b19a-777bcc9505cb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ac13d263-f966-454d-b693-0fde7ae9c3e5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a79dec4b-16a2-4427-a2ee-f35986d013be",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-25T22:00:55.0132799+00:00",
"db_currency_id": "887a356d-a72b-4dff-8f15-9fa1e1627974",
"db_currency_code": "sample string 10"
},
"company_type_id": "c7d76b55-fc82-4430-af3f-e0bf99ecee8c",
"company_type_name": "sample string 32",
"company_type": {
"id": "88454fc8-120e-471d-84bc-c9cf77d1e286",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65b19887-0bad-40f6-aaff-a108607ec440",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ebef16b2-1d44-4e3c-9e15-bac77349baf2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ea398d77-c0ea-4ce9-930f-cc6258d978a5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fc02feaa-390f-43fa-81c4-2f4a0d5d4856",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f7bd0a77-6e7d-4897-a5f9-00548f243602",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-25T22:00:55.0132799+00:00"
},
"company_sector_id": "28702e77-6205-46bb-8134-bfc20c69f3cb",
"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": "3a2cbcc2-9261-4069-bdc5-0af0f4bd5988",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "203d79db-17e7-4dd5-8d1e-69942f095c1c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1a1340a5-44f8-4be3-937f-b0fdd9e0235b",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ac5df1c-49c9-490f-b5ef-90c935ea7f2f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-25T22:00:55.0132799+00:00",
"id2": 60
},
"db_language_id": "50064341-c87f-423e-9ed6-0bd0afbdcb41",
"db_language_code": "sample string 7",
"db_title_id": "658507af-f0b7-4399-8956-0a692c546625",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-25T22:00:55.0132799+00:00",
"create_date": "2025-11-25T22:00:55.0132799+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-25T22:00:55.0132799+00:00"
}