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": "b7a62ff6-ffcb-4625-b93e-30cc08bd7ed7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b7e2e77f-8572-4789-b006-632892b3f6a7",
"company_code": "sample string 5",
"company": {
"id": "ca8989cc-1fc3-4cae-8df8-5ce215d6ecee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T20:50:39.6175966+00:00",
"sales_territory_id": "338739e5-a3c5-4847-bee5-19abc6c03543",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "45ed7a5e-c711-4f50-977b-d8de5d922d6b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5bdf5090-b01c-4bab-9764-5e194d52c730",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d23ef92-8ba7-4001-9499-17e19d1f911d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b847c09c-5c10-4cab-8bbe-b1d7e214b3df",
"db_currency_id": "74f04e27-4ebb-40bd-8cba-e03c20c2d181",
"db_language_id": "a5878578-9d0a-4a52-b620-8e596669cc0e",
"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-05-07T20:50:39.6175966+00:00"
},
"modified_dateutc": "2026-05-07T20:50:39.6175966+00:00"
},
"marketing_segment_id": "ac09c9ea-cbd6-41f7-939b-3cd3cccc63dc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6ff93fc9-1e52-4142-94c6-3b30b35652d7",
"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": "69646a3d-c51f-4319-b2b3-b182270b7b13",
"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": "beb9d939-0991-4124-a46b-7a09345e6c78",
"db_country_code": "sample string 28",
"feelist_id": "b5856cfc-0907-4bae-8ea3-ebf519cc40b2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "04e3711b-8c8d-486c-9e1f-aced5ef585dd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "df523932-a913-4a54-b3ac-91e1dfd2ac9b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T20:50:39.6175966+00:00",
"db_currency_id": "e7957b38-0ba7-498c-af39-54750936467e",
"db_currency_code": "sample string 10"
},
"company_type_id": "f577f053-f490-43ac-94da-4da058822bfc",
"company_type_name": "sample string 32",
"company_type": {
"id": "dc693905-abd6-41a6-ae06-a81894875d2a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58b0ce4e-2ae7-445e-a017-873ed27b66bd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0453df8a-3022-4f95-93d9-c68131b91c9d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32607205-5fd6-4d0a-acc8-8bd6a5694178",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e9e79bff-3b9b-4e26-bca5-2db46954677e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "aeedc257-f7d1-4c81-a086-5f077d1bf087",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T20:50:39.6175966+00:00"
},
"company_sector_id": "3655c6f2-3e77-4110-b7c3-a563bfff5681",
"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": "e34949cc-8099-452c-b5d4-b864be1439ba",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1bc48a54-265d-4da0-bedb-2b8659d1acfc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bad7fe1b-4266-4d52-bed5-85dd916cf5b7",
"account_manager_user_code": "sample string 56",
"company_status_id": "a7c2a19e-6919-41d5-a7dc-a9c06403bca9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T20:50:39.6175966+00:00",
"id2": 60
},
"db_language_id": "761f27e3-9144-46ee-a8e2-15506a3bd2f6",
"db_language_code": "sample string 7",
"db_title_id": "4c89b133-fdd1-4fcb-b9d1-17533cff14a3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T20:50:39.6175966+00:00",
"create_date": "2026-05-07T20:50:39.6175966+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-05-07T20:50:39.6175966+00:00"
}