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": "2229d0cc-e68f-4c0b-9ddc-9401eaf516cb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c54e3be3-5374-463a-aff8-de954b5c31b8",
"company_code": "sample string 5",
"company": {
"id": "55cc2517-8260-4544-8a2b-2c209abddee4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-08T22:40:36.8520491+00:00",
"sales_territory_id": "a5c37ae2-05a4-47cb-b910-78a56f68666b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "229828fe-9ce7-43a1-b511-c85fa42e7c58",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "14560211-0164-4e53-80c0-e3da4b9b740e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d66be80-5192-4549-b22c-2117a101615f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5f14b9d-2ad3-4fc9-a625-6d7d1c87e7e3",
"db_currency_id": "489295fa-3f83-4350-a65e-f9b791634a83",
"db_language_id": "17291e71-502c-461b-83ba-621d30ba6304",
"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-08T22:40:36.8520491+00:00"
},
"modified_dateutc": "2026-11-08T22:40:36.8520491+00:00"
},
"marketing_segment_id": "968d5ca5-3605-4ff8-97b8-f93a0143a89f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a4c7e2d0-6834-491d-b880-947dc139d716",
"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": "65e065e1-e1e9-4d8c-b218-32c37331f93d",
"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": "bf45fe72-a912-45a4-b2a5-469c62d0d748",
"db_country_code": "sample string 28",
"feelist_id": "f0ccc035-fbee-4a6e-a9da-0bc202919113",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5450276b-660f-48e9-9deb-1c631973311a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "859e30fe-b932-4c5f-9fef-b75709c49aca",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-08T22:40:36.8520491+00:00",
"db_currency_id": "7a6c98c4-a3c0-4d0b-9387-51eef6226a12",
"db_currency_code": "sample string 10"
},
"company_type_id": "70d53070-e689-4bde-b1d5-3a1ab92245d7",
"company_type_name": "sample string 32",
"company_type": {
"id": "de42746a-d639-4c92-b422-d2e67bcde4dd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b6fc6a3-5b93-440f-808a-edc5fc173c6a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "53e63bc0-df29-4696-b12b-bd221d3a2752",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8e768f8c-8787-48e4-b772-fd88c0044b6f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7202bdfb-5f25-490f-bd4c-1cceaacd4d5c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5b618d06-e455-4b11-ae1a-6a506d937c11",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-08T22:40:36.8520491+00:00"
},
"company_sector_id": "32102145-fa13-4b51-8f9c-ab1fd7bcb706",
"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": "cd54b4b5-06b7-497f-8b37-7c735864be64",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f25c8291-20d6-4637-b962-fc4b6e69cf6d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c30b4149-a640-412d-a879-9eb3ff76f494",
"account_manager_user_code": "sample string 56",
"company_status_id": "35e8ef9a-4bf9-4a86-8c3d-839683a49d15",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-08T22:40:36.8520491+00:00",
"id2": 60
},
"db_language_id": "0da8f361-c88e-47c1-8709-15db27bd089c",
"db_language_code": "sample string 7",
"db_title_id": "aa2956e1-2eb9-4f85-a2b5-250705eed9a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-08T22:40:36.8520491+00:00",
"create_date": "2026-11-08T22:40:36.8520491+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-08T22:40:36.8636968+00:00"
}