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": "2d96c3d4-2746-41fc-ab91-be0f69f6dc80",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dcc5846d-22e0-4627-b0a9-de6629d05e9e",
"company_code": "sample string 5",
"company": {
"id": "fb16ba2a-54ed-42a7-8a0b-53476a978629",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-12T02:56:55.9232464+00:00",
"sales_territory_id": "59255862-706e-471b-bc97-26d1fd1e7db9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6a28899d-dd26-4e42-89fb-8af736d7f1d3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a9efcca4-f019-49f5-afb7-ec1b410ea6d9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ab96c9a-69fd-46ef-8fee-47eeae6d0b5e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75fbc4d5-4a65-4032-b367-7142395a85fe",
"db_currency_id": "29ab07df-6d74-42ac-a737-176cff0e28e4",
"db_language_id": "0becbe92-9a91-48bf-b835-18a2b98d34ff",
"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-08-12T02:56:55.9232464+00:00"
},
"modified_dateutc": "2026-08-12T02:56:55.9232464+00:00"
},
"marketing_segment_id": "7d06bbff-a4a7-4921-9204-165751374029",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "993d21e3-a4e9-4da7-92a9-7acc87c148f1",
"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": "5993f145-96f7-4348-8f61-5de60d863e61",
"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": "37cdf1f1-e66d-4225-9e58-5673349ffdb3",
"db_country_code": "sample string 28",
"feelist_id": "c5b1db71-bbff-4c4a-bffa-531f92eaf7f1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cd61c197-3dbb-4b4e-ab1f-459506b75f80",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cbae91f0-8ad2-418b-874b-a1ba22481a58",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-12T02:56:55.9232464+00:00",
"db_currency_id": "15130ab3-ceac-4e52-83a0-5b2cf8d9b2b3",
"db_currency_code": "sample string 10"
},
"company_type_id": "79b0de30-9383-40b0-a1a2-b92d97d7cb7f",
"company_type_name": "sample string 32",
"company_type": {
"id": "7d6de54b-81a4-4575-a97c-9b1542d89896",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7ae68bc1-1ffe-4976-af4c-3d7a10cce2ed",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6dcd2645-37aa-4885-90f1-135059dc6bd5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7577270d-864e-487b-bc15-6ea3a3ab106f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "decc0d34-d51c-47dc-a154-c870004f9c3c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "66829535-91db-49d5-994c-40fe88272980",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-12T02:56:55.9232464+00:00"
},
"company_sector_id": "b63ded7a-c6e5-4363-a9df-b53dfc4ce8fd",
"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": "5af0030e-706a-43b5-adcb-ca0723a3d302",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8113d322-03d7-4f50-bb39-3bcc3e1ecf27",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "657fefc5-3c79-481f-a170-1a8697cbfb45",
"account_manager_user_code": "sample string 56",
"company_status_id": "29bbc814-6a31-41d9-83a0-81540b66683f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-12T02:56:55.9232464+00:00",
"id2": 60
},
"db_language_id": "6171e147-8338-4070-a821-097f98187f95",
"db_language_code": "sample string 7",
"db_title_id": "7f7e7ebb-8b29-4842-971f-12e129b98f17",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-12T02:56:55.9232464+00:00",
"create_date": "2026-08-12T02:56:55.9232464+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-08-12T02:56:55.9232464+00:00"
}