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": "65d8323c-643a-48b1-9c03-d7bd42295b05",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a99494dd-3a38-4aad-aa57-6b72116c48d1",
"company_code": "sample string 5",
"company": {
"id": "12dbdaea-07f1-4187-aa6e-b9dadf641573",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-05T05:34:16.0181601+00:00",
"sales_territory_id": "cc1fa773-767f-483a-b192-d85bc5511292",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dfd43ba2-8d27-44bf-8b07-dfadc9a2a915",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c3828a2-ea30-4e72-a468-0369fb47ff50",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b050cb9c-8280-41f5-a96d-b41a37566be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66993c8d-a0fa-48eb-a920-0282ab448bb1",
"db_currency_id": "79a75162-1491-4183-8fb9-1ac6627f06e0",
"db_language_id": "5c179316-43bc-4cbc-9f72-abbc0dfd7ee1",
"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-09-05T05:34:16.0181601+00:00"
},
"modified_dateutc": "2025-09-05T05:34:16.0181601+00:00"
},
"marketing_segment_id": "dd41bd38-676f-4c16-a626-cbc8294888d7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a0492822-67d7-461e-8762-80db51e3c734",
"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": "c528fe2a-1ef8-4aa3-9881-6105bbb96928",
"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": "d7c68ab5-f19a-4e9e-b9eb-edfe8fda4d78",
"db_country_code": "sample string 28",
"feelist_id": "db60dde2-484f-44ef-8286-f6ca02640419",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6c29496c-b4f5-4392-9ce6-d48296736d6d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fcf47f77-1d4e-4299-b253-0a83b9af35e5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-05T05:34:16.0337859+00:00",
"db_currency_id": "004dd280-dc5b-48c6-92a0-6cd0f7080f08",
"db_currency_code": "sample string 10"
},
"company_type_id": "3c02af0f-8887-4e84-80b4-03140fc6c608",
"company_type_name": "sample string 32",
"company_type": {
"id": "843730dd-ee9e-49f7-942f-559b40fbb767",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "010ebb8d-8df8-4f96-9134-5a898650a6a6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0d8ca940-81e6-4f23-91ad-36dc1ac50afe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7776f1a8-c38b-4a3b-9653-fa1c77d1f97a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "19ea3c8a-6ae5-4879-81ff-a5c57a34e471",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cfa4ea4c-b863-40b6-990b-ea4293850432",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-05T05:34:16.0337859+00:00"
},
"company_sector_id": "9883fe67-48f4-4bdb-82f5-ac54f553d4ef",
"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": "345e2d43-3598-4c57-8408-be0fe1a39d91",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b131d1f6-0b05-46ae-ad71-ff92e1c7bee8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c4ce5891-a8d6-4dda-b0d7-febaaa4a70bf",
"account_manager_user_code": "sample string 56",
"company_status_id": "bc2d6cfa-2081-42b4-a00a-99c3cef05b95",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-05T05:34:16.0337859+00:00",
"id2": 60
},
"db_language_id": "49bd6d27-d4f0-4e00-bdd2-f923fa86145e",
"db_language_code": "sample string 7",
"db_title_id": "0007440d-3aef-4842-a79c-225d81f9fda8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-05T05:34:16.0337859+00:00",
"create_date": "2025-09-05T05:34:16.0337859+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-09-05T05:34:16.0337859+00:00"
}