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": "8a3f8203-4b34-497c-b9de-82a9a168b717",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d620d5e6-2266-4ecd-b66f-6f0367e2b429",
"company_code": "sample string 5",
"company": {
"id": "11095ee5-01a4-4926-ae86-62bfdf9cec1b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-08T11:46:44.0279329+00:00",
"sales_territory_id": "a2c9e5c2-e91a-4ebc-9563-b58426e15608",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "05235151-338f-47cd-a302-0503ab314330",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffae297e-e5ed-4a99-b9f2-693b5e990b61",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f24af27-09c1-4435-bd14-3f758a94d401",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef3f2d7f-bf5b-4810-ac0f-2c5bba73477d",
"db_currency_id": "d8055af2-a433-4e50-9a8c-239b2d04c291",
"db_language_id": "a69efa01-1bd2-4419-af6e-8fc9cb450072",
"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-07-08T11:46:44.0279329+00:00"
},
"modified_dateutc": "2026-07-08T11:46:44.0279329+00:00"
},
"marketing_segment_id": "d3dd04eb-a67a-47ef-83e0-6931af9d3d6d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "51f80a8f-9f97-493d-9063-b798742f2380",
"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": "3ada6b7b-275d-4507-976c-9298ee35a6ed",
"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": "0bbc125a-ea3d-44a6-9216-11e400e7651a",
"db_country_code": "sample string 28",
"feelist_id": "fc6fcfd0-23b9-4215-9889-29ff951dd05e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a42fc047-87db-4a04-9673-f88aa2266a18",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "86c0e8b1-976d-465f-abe5-e7e8446b4b93",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-08T11:46:44.0279329+00:00",
"db_currency_id": "9d81ce7a-92f7-4086-bc53-2e920cb60563",
"db_currency_code": "sample string 10"
},
"company_type_id": "f8b684da-7f27-4ec0-960a-d58978f5dae4",
"company_type_name": "sample string 32",
"company_type": {
"id": "55792626-506f-4f84-b6e9-9213773d8780",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b1c56ce9-6a20-45a6-a31e-edc0ee5a31a7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "252e2ee7-05fd-43f7-896f-e6ee603721fe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0688b0b2-4f6c-4d3e-90ee-d7d9050324df",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "45871836-d067-4995-baad-a61bf63c82b2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8ec24d1c-ca39-45eb-9693-4d910bd8f81d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-08T11:46:44.0279329+00:00"
},
"company_sector_id": "385cc6f5-1552-49dc-ab33-ae455cbb346a",
"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": "567a6cb8-dc41-4f50-afd8-a76629576ed3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0182e1a6-9559-4fe3-aa95-bcd6a00457ea",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cf9dcf01-7f98-4601-8be6-688ad7f63968",
"account_manager_user_code": "sample string 56",
"company_status_id": "fac70713-079c-4372-a454-60f48aa56d49",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-08T11:46:44.0279329+00:00",
"id2": 60
},
"db_language_id": "e4fbbcda-c2f0-4788-9cfd-bf7e64a1b0ab",
"db_language_code": "sample string 7",
"db_title_id": "e241499f-4eeb-45ff-b8c9-8f15cdf30567",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-08T11:46:44.0279329+00:00",
"create_date": "2026-07-08T11:46:44.0279329+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-07-08T11:46:44.0279329+00:00"
}