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": "def4b056-20ab-495f-b6c2-52435d81fbbf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fc03ca8b-c4c7-492b-b13f-baf683a743b2",
"company_code": "sample string 5",
"company": {
"id": "29fe5b54-ca5c-4619-bf78-966f6e10e532",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-29T02:49:48.6396174+00:00",
"sales_territory_id": "78ff2a95-182b-4cd1-8df8-23351f1f4ce7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50d91ffb-466b-4b1e-9c2f-8f12ad0f45f7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "514fab89-ee4f-4c25-8f71-78958f889f45",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "88ce3b66-1463-4ade-8cc5-0f98a2017e8c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c07f965a-3ac8-4fcc-b1f9-e5f104f7ab8c",
"db_currency_id": "c321d33f-060a-48d2-9fc3-c2a79171a386",
"db_language_id": "2820f737-3ba3-48fd-bf6e-a4e08d70c9ff",
"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-29T02:49:48.6396174+00:00"
},
"modified_dateutc": "2025-11-29T02:49:48.6396174+00:00"
},
"marketing_segment_id": "ad1aad05-d92b-4eee-904f-7011acf9f50c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0e5fdfd1-3d3e-4ae3-ac5d-f9693947f196",
"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": "b373467a-e6c2-44b9-a57c-cdda8c96c77d",
"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": "c64ae325-82e8-4563-adc3-4ca08e3c2d30",
"db_country_code": "sample string 28",
"feelist_id": "778501bf-d537-487c-9527-57c55971f732",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0a69c76f-1670-4ebf-b1b7-e20a20488074",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "55eb1007-17c7-439f-9ecc-85cccee90ccf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-29T02:49:48.6396174+00:00",
"db_currency_id": "de46d18c-a71a-4644-bcfa-3cd585efc7a0",
"db_currency_code": "sample string 10"
},
"company_type_id": "d5416ddf-3944-48d1-a186-beab211dae8c",
"company_type_name": "sample string 32",
"company_type": {
"id": "5718c120-21e3-4995-aa1a-5742e7052b9b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f1f041d-a794-4fad-baa7-f67ca516d69f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3c35b8cb-f892-476e-a81d-605ca07be376",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f77e0290-bb32-4d0d-901a-8d683b97080d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1d57cbce-9c1b-4c13-b141-c8f475d8af1c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "24d3545e-ec5d-4505-bdb7-e0903bac47e7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-29T02:49:48.6396174+00:00"
},
"company_sector_id": "c7459487-00cf-4567-8a4b-f8bc29c5032e",
"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": "03850521-3f4c-4ba4-87a9-1ce2ea05e451",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "91a59227-49b4-4d79-b5fb-a93813780084",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dd9b6be2-3a10-4d39-8b48-9a11e1e5988e",
"account_manager_user_code": "sample string 56",
"company_status_id": "1732d52f-f35a-4259-94bc-40510fb4fc80",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-29T02:49:48.6396174+00:00",
"id2": 60
},
"db_language_id": "b9169fec-ac45-47a1-969d-526b69af7883",
"db_language_code": "sample string 7",
"db_title_id": "452d82bd-6cbc-4d75-8f76-63b477b55a15",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-29T02:49:48.6396174+00:00",
"create_date": "2025-11-29T02:49:48.6396174+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-29T02:49:48.6396174+00:00"
}