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": "3acf89f9-05fc-423b-bc26-f246e2910809",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "181eb360-7a9f-4fa2-bb3b-6e59dc3a7f61",
"company_code": "sample string 5",
"company": {
"id": "f04bca4d-5db9-4483-af4f-8ca1fa0a93f7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-23T17:22:14.295232+00:00",
"sales_territory_id": "a282f4c3-6d49-4ac6-9262-1c7569687316",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7970a91a-6635-4f0a-ab20-5dcb2893a108",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e883c31-d4c8-4a10-905f-553a664d0780",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "590d0f26-2341-4719-b872-5fa3d6912e9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "edc69938-48de-4111-a32b-850fb3dd3f92",
"db_currency_id": "a6311a2b-c90e-4bca-a61b-640248f9e770",
"db_language_id": "35bf98ac-78f0-4883-8121-7da7aeee45de",
"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-10-23T17:22:14.295232+00:00"
},
"modified_dateutc": "2026-10-23T17:22:14.295232+00:00"
},
"marketing_segment_id": "f27ce0d9-d861-47c8-8476-8dc7b4c76809",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "089af134-9684-4881-8c86-0b2001ee187e",
"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": "ae526164-8af4-4a54-b43a-f5ee7e238d81",
"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": "887edab9-fd8e-47c9-a264-ce816a5fa3d3",
"db_country_code": "sample string 28",
"feelist_id": "50979289-0798-4ae3-be64-690d74a2356e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bd25143c-0ba9-4dd9-98b3-a5050ece1233",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "122eed86-f7d8-499b-8bb5-d3395088795d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-23T17:22:14.295232+00:00",
"db_currency_id": "0a0bce2c-de24-4b2e-82b9-165bae5b62aa",
"db_currency_code": "sample string 10"
},
"company_type_id": "540a0426-1f51-486b-8dc9-9e866964aaf2",
"company_type_name": "sample string 32",
"company_type": {
"id": "809d18d2-1492-4179-878e-e8fb26c91b6b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d75d63d1-b987-40b9-b421-c0ff891bb908",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f20c037a-acf8-4366-812d-18fe398d0a60",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "006bb748-6899-45fe-81a8-72ddb2361a74",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1244b434-ee34-4490-9b59-e1fd8c30cd90",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b2a2d250-d927-4b50-a014-378c8f528b0f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-23T17:22:14.295232+00:00"
},
"company_sector_id": "07cfdb9a-f656-4cd0-b9be-fc3667027cd2",
"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": "1628ce37-00a3-4818-8323-4a6d41df8b65",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4f27587f-b8fd-402f-a9bd-f83c0393abed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a7ab2e12-6877-40c2-a396-ba2a741fff44",
"account_manager_user_code": "sample string 56",
"company_status_id": "7c9055f0-2d04-4b2f-bc24-2db4ab5830ab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-23T17:22:14.295232+00:00",
"id2": 60
},
"db_language_id": "9e4cbb25-eb9f-4a6c-8daf-24ce4a15fdbf",
"db_language_code": "sample string 7",
"db_title_id": "54dc0033-571f-491e-9b1c-423d8ad4d9f5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-23T17:22:14.295232+00:00",
"create_date": "2026-10-23T17:22:14.295232+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-10-23T17:22:14.295232+00:00"
}