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": "57217c7d-5f00-49af-b75a-efa88a47098d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b71e14ca-0232-4d4c-87c9-7390d99e71a6",
"company_code": "sample string 5",
"company": {
"id": "3b6f48f1-4041-45c8-9a95-383816399d49",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-11T18:42:44.9818845+00:00",
"sales_territory_id": "702ee9c5-05a3-451f-a6de-9fc804e2c4b2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5eefcbe3-ed45-4a3e-adaf-c04f03b51057",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b611947a-995e-4166-a9b5-ef5bffaa1adb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7e0a14ac-5340-431e-aa6d-1ca5bdc8f794",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21c85c88-4906-4a3b-95ec-7c6c1e0b6f5e",
"db_currency_id": "e4de978b-f6c8-4e63-9957-1360fbd186a4",
"db_language_id": "4934b03d-31e5-4ab8-af99-717f8dd5537f",
"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-04-11T18:42:44.9818845+00:00"
},
"modified_dateutc": "2026-04-11T18:42:44.9818845+00:00"
},
"marketing_segment_id": "b10946ad-26c0-4e98-93c4-75c33d20e379",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0b6a6cf3-cd49-4016-972b-a80bd71590f7",
"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": "e1eee076-1834-420a-96a4-6fafc215d0c7",
"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": "71d97161-85ed-4a2e-a503-3572025a5d03",
"db_country_code": "sample string 28",
"feelist_id": "42e33b45-bd23-4ba8-83db-6fe25214946f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "211cac2e-8752-4789-8dfd-e539390f266e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b50777d1-b8b8-46c1-b6f3-7453527f85e6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-11T18:42:44.9818845+00:00",
"db_currency_id": "dc79ba36-708c-4f4c-b2f6-4e3c6f7e9818",
"db_currency_code": "sample string 10"
},
"company_type_id": "39bfc85a-a7e2-422c-8bea-94f531348ae3",
"company_type_name": "sample string 32",
"company_type": {
"id": "a79a849b-8f42-4b9f-97e4-990cf0094196",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9d310fe4-b516-4dd9-a692-c982012585ba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36d7da24-081c-4e4d-ae35-68335ca45e04",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d6f9861a-4e7b-4930-ab0c-35b804382be9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d2336558-5e95-41f8-96d6-bd714dc5b9c9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "71fbf921-1d95-44f0-9c56-39cc8c1c173f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-11T18:42:44.9818845+00:00"
},
"company_sector_id": "36597c2e-7f4c-4a27-896b-f601380d0e1e",
"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": "677b4b65-f115-4018-84bc-d3a36b0c4f6c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "04b359fe-11ad-4d5e-8515-2e3f1f43f67f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fd4a4c87-5a3a-4337-91a7-e07b1c8f2662",
"account_manager_user_code": "sample string 56",
"company_status_id": "dbabad6a-a9c6-46aa-855c-d343139b048a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-11T18:42:44.9818845+00:00",
"id2": 60
},
"db_language_id": "186d773f-8ab9-4e8f-8984-4516b2d9d2ea",
"db_language_code": "sample string 7",
"db_title_id": "d51bac48-0ac4-46ab-ba5d-7230a7ccd201",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-11T18:42:44.9818845+00:00",
"create_date": "2026-04-11T18:42:44.9818845+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-04-11T18:42:44.9818845+00:00"
}