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": "934a0274-7f3b-45ea-8e09-8fd7a8500034",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "18d5f8a1-576d-4d0c-986f-304605cbd1e4",
"company_code": "sample string 5",
"company": {
"id": "10f60910-33b1-4f6a-988b-03bb50b74fea",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-18T09:24:06.9354723+00:00",
"sales_territory_id": "d0fefca1-77f9-49f0-b728-926a5db6fc20",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0f67cb04-0111-48a2-bbb3-b2cce8c36ea3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3c44a137-1f7a-4a7c-82dd-72d32be32028",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08f093c4-88e2-474f-888e-f67a44b8735c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "629d3d10-9cb0-4f0f-8821-230040292c97",
"db_currency_id": "a5bf08c5-538d-4aad-bce1-3e483060b3bf",
"db_language_id": "627c702c-bc7f-47a0-ae1d-83ea0fc9a456",
"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-18T09:24:06.9354723+00:00"
},
"modified_dateutc": "2026-02-18T09:24:06.9354723+00:00"
},
"marketing_segment_id": "416c8a5d-4903-4e8a-900e-41ac3dfaa000",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "0e3102e8-e0b3-4427-bdfe-b1784e8d08a3",
"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": "c08ba8d9-13f2-4891-8c31-047be254be69",
"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": "7759c1fb-b857-4287-948b-dcf8c6cec022",
"db_country_code": "sample string 28",
"feelist_id": "cd738cb6-3b86-46c1-8c1e-04f6a960d823",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0eb959fe-e756-44e7-9c11-7de22edd80c2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "88533ebb-67b8-4889-8812-846a84377574",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-18T09:24:06.9354723+00:00",
"db_currency_id": "3e358e76-2b24-46b8-8167-9ed0e83e3669",
"db_currency_code": "sample string 10"
},
"company_type_id": "31ce47db-1ea9-4a23-a668-9b760b7abd1d",
"company_type_name": "sample string 32",
"company_type": {
"id": "b8ab1f2a-c98b-43c9-9bd5-c3c6d6585c4f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d3c9b336-455b-4681-ae5f-4b982d864c31",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5b708915-07f9-4cf7-931d-3ff98e5824f5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e0a2ff74-5d17-4ad5-873e-e8551bfe8656",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bc627ece-c214-4304-8bdf-4b190040b178",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "99920f39-1c8c-4cca-9bf2-c9cf63333c0a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-18T09:24:06.9354723+00:00"
},
"company_sector_id": "0d361068-6e32-4dbc-8740-2bcd08dbc3d7",
"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": "7a535f06-812b-4e83-ae3c-71174427ab00",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c7e19b55-5cb8-42f2-98c4-21b3f716d37a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fbc36129-75e5-4b2b-b12f-19ba8740ce36",
"account_manager_user_code": "sample string 56",
"company_status_id": "af2d06a5-10b5-497b-b110-e6d7b1413c68",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-18T09:24:06.9354723+00:00",
"id2": 60
},
"db_language_id": "cda7c67f-9024-416b-9cab-6b6175b8e51d",
"db_language_code": "sample string 7",
"db_title_id": "6cfcc534-9a45-4631-b7b7-fe1ed6a2adcd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-18T09:24:06.9354723+00:00",
"create_date": "2026-02-18T09:24:06.9354723+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-18T09:24:06.9354723+00:00"
}