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": "ff78af24-d87b-497b-a912-aa84623236d3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "31d54d7d-c613-4d7c-840c-1f8dfa2148b9",
"company_code": "sample string 5",
"company": {
"id": "47b21e6d-cecb-45c2-bf70-a747bfa9969f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-03T03:45:17.9465559+00:00",
"sales_territory_id": "d6c5d4d8-3bd3-4a82-8c84-20312e2a028f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "240a1ddd-b8fe-4f58-985b-5fce6ed6a22c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d566d65-196f-44be-a2d7-f5dee7a474a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0bfdce1a-5551-4aea-a1a1-9aadfc1dba03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61373bbc-46bf-4d6b-a330-33ff1e1375ab",
"db_currency_id": "c1e700f8-a474-44ef-a7aa-4ce5ab0347e6",
"db_language_id": "85d37618-7173-4eda-8548-56a719ba8e87",
"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-02-03T03:45:17.9465559+00:00"
},
"modified_dateutc": "2026-02-03T03:45:17.9465559+00:00"
},
"marketing_segment_id": "81fbbee6-47db-41a9-8ebd-97e9cbc26641",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c8afe613-56b4-445e-afd9-56af85d6f7ed",
"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": "fa577f2d-0da4-4f8a-9367-a8c23772cd2e",
"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": "024350bc-bbfb-4fab-9e1d-b39fbe03028e",
"db_country_code": "sample string 28",
"feelist_id": "d365a05a-47c5-4972-b13a-7b48d551930e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a940004a-cea1-4eba-bd7c-38ba02cbe734",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "149f160f-6281-4e3c-8c4e-4cc96a408679",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-03T03:45:17.9465559+00:00",
"db_currency_id": "543ae4b0-2988-4a04-a744-4ba0c99bb4a8",
"db_currency_code": "sample string 10"
},
"company_type_id": "e9c8b0aa-1fe4-49ee-9ca9-945f55530c24",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a85448f-997d-4ace-9e9f-bce2a4bcfb4f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e68988c8-17bd-42f3-835b-0181c83e0467",
"sales_organization_code": "sample string 5"
},
"db_language_id": "04595733-6968-4efe-8d46-78659e03f9c9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "328d2d57-1039-4974-8177-2664eb5d64e1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "639609a6-b6f7-402b-9cb0-5be950be5e0d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ce504fd9-4cb5-449f-a0c5-9f7b42d47527",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-03T03:45:17.9465559+00:00"
},
"company_sector_id": "e66b3737-3d5a-4c90-8a61-6008a25a60e4",
"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": "6e75af0f-9ba7-4d8a-b609-62c3469a6d13",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b1c246ce-6b1d-45fd-ab6d-a60300980af9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "88164e53-4488-42d8-8a70-3333f3e8bae1",
"account_manager_user_code": "sample string 56",
"company_status_id": "6ef66f18-b2ee-4351-84ff-08e0885a46a2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-03T03:45:17.9465559+00:00",
"id2": 60
},
"db_language_id": "7ee0a851-90a2-4b98-a6b1-c8d723d8ac07",
"db_language_code": "sample string 7",
"db_title_id": "1be279d6-df31-4c07-aeb1-bed21b2f6196",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-03T03:45:17.9465559+00:00",
"create_date": "2026-02-03T03:45:17.9465559+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-02-03T03:45:17.9465559+00:00"
}