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": "35a12af3-a651-432f-a369-04a2e0694391",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d42756e6-9c85-4d82-843e-3fca01356e03",
"company_code": "sample string 5",
"company": {
"id": "3a82cf94-9c00-4395-96fb-dc22665c0fde",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-11T11:07:08.6752088+00:00",
"sales_territory_id": "70b1de48-b3b8-455f-a3e4-da87dea25211",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "db7b2eb5-b077-4c28-ad3d-f0c4af555c7e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "02478024-2485-40f8-8a64-21264b8820c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b82a8721-c945-4b58-a383-f4381907beb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "543e3b27-c812-443d-a5f9-77c8a064d165",
"db_currency_id": "ec3149d3-ae67-4c16-b23b-973849ee4530",
"db_language_id": "d70488f0-3f77-41e6-b317-4b2982ae596b",
"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": "2025-08-11T11:07:08.6752088+00:00"
},
"modified_dateutc": "2025-08-11T11:07:08.6752088+00:00"
},
"marketing_segment_id": "d081a934-5cb5-49e0-ac93-071bcba63ee0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9af37908-422e-4458-849f-4ea3ba537ca5",
"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": "007605e8-1339-4ba9-87c8-b87e4c964f38",
"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": "b0485ffc-7563-42b8-a61d-a56cd6df9a12",
"db_country_code": "sample string 28",
"feelist_id": "a66785ef-17c0-4250-a7b7-d4112b6441e2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3c9d784c-cd7c-41f4-a3cd-c59ec4f26645",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "23e46792-8ed0-4eca-b37d-f2dd2a0e5667",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-11T11:07:08.6752088+00:00",
"db_currency_id": "16e74198-59de-4408-b2a7-78917f93283b",
"db_currency_code": "sample string 10"
},
"company_type_id": "7dc71f18-5e22-41a9-a016-a33ab9888b50",
"company_type_name": "sample string 32",
"company_type": {
"id": "a7a713f9-635f-48fc-a711-0f3da79e5826",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e3957f8d-0306-4601-9c27-7a688e4cd5e7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "97b59b38-2db3-43dc-b9d6-e815831fbee5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9a81da0e-06fd-4087-b07e-e704cca27658",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fd944f9c-6a1c-4b89-8738-d567fc2b4ed5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4a8e5943-e289-4502-8a10-dcd884c6599f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-11T11:07:08.6752088+00:00"
},
"company_sector_id": "fdae9587-c6af-4430-89e8-03da2c3a4a5e",
"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": "39284201-1b3a-4126-81bd-53d6b42ca6e5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1a46fb18-219b-43d4-9ea3-7a9ccea75016",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cb59de47-9636-4ff0-96b7-81f928576e6c",
"account_manager_user_code": "sample string 56",
"company_status_id": "5876098e-7746-47ca-8ca7-18806817ba0d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-11T11:07:08.6752088+00:00",
"id2": 60
},
"db_language_id": "c64f5c24-1449-458c-b8c2-6108284a564b",
"db_language_code": "sample string 7",
"db_title_id": "59071242-9e90-4a12-a325-ed5b2d3c2e7b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-11T11:07:08.6752088+00:00",
"create_date": "2025-08-11T11:07:08.6752088+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": "2025-08-11T11:07:08.6752088+00:00"
}