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": "a6ed9412-ac50-494d-9e68-d30e56096b24",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "efc93024-5776-40fb-b766-59a301f905f6",
"company_code": "sample string 5",
"company": {
"id": "a16716fe-1bd7-41ab-a26e-5789147f559e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T08:52:38.2939813+00:00",
"sales_territory_id": "03cebb13-376d-4002-a37b-484dd5f20e3e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "30da913e-a489-4916-b2cc-929d590a4d0e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e7a3efc0-418f-4626-9801-b30bdc64e0b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0656e2a1-ef63-450a-ba60-6ccc292bdef2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0431f096-25fa-44a2-a83b-5d8a14dc571b",
"db_currency_id": "32f458a3-fb17-4e8f-a865-7c670cacddfd",
"db_language_id": "579ce0be-2867-4e66-b319-cf966e29eca9",
"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-06-26T08:52:38.2939813+00:00"
},
"modified_dateutc": "2026-06-26T08:52:38.2939813+00:00"
},
"marketing_segment_id": "fc373a43-a70b-40c0-ad10-dec79e0ab109",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dd9d5bae-8623-4207-b24b-f881a8588c30",
"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": "a11987e1-4b3c-4fea-9579-aca72cb9c801",
"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": "f83376c2-f913-486e-a25f-cc9fe6fdcd9a",
"db_country_code": "sample string 28",
"feelist_id": "c144b747-c450-482d-8bdb-6dcb71af5833",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7548efb8-ac33-41d2-9646-ffebf9700b4f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "68361a37-fdcd-4d5a-becb-753ac80c8215",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T08:52:38.2939813+00:00",
"db_currency_id": "282769c2-4c4c-49d2-937a-efe44b4b1eb3",
"db_currency_code": "sample string 10"
},
"company_type_id": "450b99ba-6d4d-4d94-b9f4-65aa7a31e52a",
"company_type_name": "sample string 32",
"company_type": {
"id": "897ebbab-6d7b-42db-8e7c-54b612b22cf5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ce611686-2743-4044-8826-9ddc3361807a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5bc1d0b2-577a-4737-a110-e74c12bc77a2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e128b161-b4dd-492e-971f-41ab7a8c8a3c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "942f870b-c35d-4d14-906e-0e0718ed6e3b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "788cc9dc-2980-473e-b17c-d8d5e88a2bc9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T08:52:38.2939813+00:00"
},
"company_sector_id": "1a531e5e-5724-48e7-9bde-920d341cd4f6",
"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": "50420a38-6303-4e35-ac85-43193a8879e1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f500b845-a589-400c-a108-4de292b1d139",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "43d4c31b-6a12-4f6c-85a4-ff9800aba910",
"account_manager_user_code": "sample string 56",
"company_status_id": "d093efe7-644b-4302-87d0-fe3ad206b6d6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T08:52:38.2939813+00:00",
"id2": 60
},
"db_language_id": "b441580e-b591-4d73-ad6a-f74e13cfd31d",
"db_language_code": "sample string 7",
"db_title_id": "ba5e4a85-758c-4a00-9539-00b6eebec3ae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T08:52:38.2939813+00:00",
"create_date": "2026-06-26T08:52:38.2939813+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-06-26T08:52:38.2939813+00:00"
}