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": "e98a4c95-bedc-47f5-ae4e-f595ea2ac629",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e13e7748-e3d8-4107-b057-af339a67f879",
"company_code": "sample string 5",
"company": {
"id": "4fcb633f-b432-493d-bf86-efccc23f7737",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-13T04:46:54.0669276+00:00",
"sales_territory_id": "0932ec95-56c3-4ffb-adef-686b9db1eeca",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7be724de-662e-44b0-af70-09bc1ff218c9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c6707f25-aef6-4902-a220-c4c1321bdae2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f13a5324-1b8a-451b-be77-61acc1725d6e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5e5a1df-b168-4ff6-8e97-5327443bbcae",
"db_currency_id": "7ab8f4a8-7b9d-4ab1-820c-32a77e961c25",
"db_language_id": "c0b5efbf-e479-4a23-bc5f-4182a036d72e",
"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-03-13T04:46:54.0669276+00:00"
},
"modified_dateutc": "2026-03-13T04:46:54.0669276+00:00"
},
"marketing_segment_id": "a1eaf889-55c0-45d7-8660-1447561ce41c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5448904c-c166-4066-9c8a-9357b7d110e0",
"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": "4e66d12f-ed83-4465-9303-6c7297e4454a",
"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": "8fa13e58-7311-46ab-9ab2-4541ad3dd75d",
"db_country_code": "sample string 28",
"feelist_id": "32c7e830-e132-4c14-8dab-8cb641b94e75",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8c04b491-b77b-4d45-97ae-6ebf243e1cb0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "84a7348f-217d-43f1-a7fa-cd6e9f2a8677",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-13T04:46:54.0669276+00:00",
"db_currency_id": "06f04062-7c51-467b-bd02-d0a420824991",
"db_currency_code": "sample string 10"
},
"company_type_id": "a1fe9ac4-2e22-4a69-bd3e-58fe5e671392",
"company_type_name": "sample string 32",
"company_type": {
"id": "90d9f91e-1b95-4089-ac6a-eedde6c8055a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1872285f-d7c0-49f0-a7ad-6011ff153ee4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "492a8c26-f5ee-4c38-a9bd-543515da621f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0235a09a-7986-4cd1-9a38-637f025c8982",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "041fac93-3c1e-4fb9-85f1-d4df479e0c0d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "55cf8b8a-c9a2-453b-9c2d-ef54cbe2f9b2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-13T04:46:54.0669276+00:00"
},
"company_sector_id": "8bf55337-ae47-4f62-8399-741ecc88bcc6",
"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": "74550d3d-4697-4620-a284-ae54654c443b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "47733382-ab8b-4323-a588-612d79cfaa82",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2b23a0bd-535d-4c97-a5c4-ce098615a6b9",
"account_manager_user_code": "sample string 56",
"company_status_id": "1f1db58a-be20-4561-86d2-25d15ee30236",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-13T04:46:54.0669276+00:00",
"id2": 60
},
"db_language_id": "0f99e764-54df-4e3c-b8b5-f74246550b3d",
"db_language_code": "sample string 7",
"db_title_id": "889d4bbe-9548-4a21-ba9b-5d81418b5031",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-13T04:46:54.0669276+00:00",
"create_date": "2026-03-13T04:46:54.0669276+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-03-13T04:46:54.0669276+00:00"
}