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": "a718087d-3455-4c38-bcf0-3132f6084dfe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7baf00b3-4900-4f30-9eb1-1a3225ae2294",
"company_code": "sample string 5",
"company": {
"id": "e5662888-de0c-44f7-9f34-1875df06b64f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-05T12:47:23.3134938+00:00",
"sales_territory_id": "214328e8-79d7-4459-9435-bc9a87b32f67",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c76ee053-a85d-42bc-bd07-0c3da5cca850",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b41cf30d-1101-47af-aea7-5b7ef191af65",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18b640cf-26b2-4673-bfd4-e2f3693f7710",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "537f753d-5117-43dd-9e68-d5f637887a2a",
"db_currency_id": "106fe811-b2ad-4c35-85ec-e0facc64df8f",
"db_language_id": "1dd4e5f8-bc97-46b9-bd25-6b42162997c9",
"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-05T12:47:23.3134938+00:00"
},
"modified_dateutc": "2026-10-05T12:47:23.3134938+00:00"
},
"marketing_segment_id": "8808d490-01df-4d61-a541-3525dda132c7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1c72e8eb-47f5-4089-912c-168567ad073d",
"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": "72e01aec-2618-4572-b161-0af69da4e780",
"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": "54dee0fd-113f-4715-9c0c-7f3b828c797a",
"db_country_code": "sample string 28",
"feelist_id": "6c3a7faf-b467-42ac-a159-d5f2cbd4050c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "371354d7-51f8-45d5-aaa4-9d48452be40f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "df147d11-7f6c-4573-a2f4-50b3c56836d4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-05T12:47:23.3134938+00:00",
"db_currency_id": "d26d8fa8-49b3-4ec4-b770-819c9ef8c2bc",
"db_currency_code": "sample string 10"
},
"company_type_id": "21b32638-844a-4a13-b8fb-bb2fd2404277",
"company_type_name": "sample string 32",
"company_type": {
"id": "84990a67-e529-4657-849d-f6618d3906b9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1516389f-db48-4626-b4cd-e0b3bd88dae2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cafa0ac0-458d-4081-b6e7-1ff5acdde450",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "cbce4478-4d88-4709-aea2-4c8060351d75",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "60f48458-f87c-4864-9f5b-e69310221d47",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "81d53ab2-4e9f-459a-aab6-3e40d00bc8fc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-05T12:47:23.3246606+00:00"
},
"company_sector_id": "36d0a69e-8e63-41ea-87c6-e772ff7e119c",
"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": "f2427dad-e7d7-4a1c-b4ac-46a52c989f98",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8ecbb143-0f2d-4c85-bace-60f455926de5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ba444e4f-322a-45c5-98bb-c192a673a286",
"account_manager_user_code": "sample string 56",
"company_status_id": "2efd9d2e-f290-4668-9b8e-a1b39b9a2de8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-05T12:47:23.3246606+00:00",
"id2": 60
},
"db_language_id": "36926fe8-1ad9-489f-ad2c-546ed2a47b6b",
"db_language_code": "sample string 7",
"db_title_id": "e75a57d8-ec7a-46f9-9b48-850e385c12e9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-05T12:47:23.3246606+00:00",
"create_date": "2026-10-05T12:47:23.3246606+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-05T12:47:23.3246606+00:00"
}