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": "b59dabdf-c71a-4fb2-af2b-26e838febab9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7e6f7e13-0479-42e4-a361-853f3d9f0664",
"company_code": "sample string 5",
"company": {
"id": "b6c97dce-5139-4362-8b91-a3718d3297fb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-24T07:10:06.5826374+00:00",
"sales_territory_id": "5b50e2a4-296a-40d2-b90f-b2d3f49c90f1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "da86c52f-c9a2-4f8e-8552-56efba26e251",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6a5de27b-5bd1-44a8-84ba-3c450c9bc0fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03d81acb-4abb-4be3-8a1a-c5006b10371b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1de3f064-b65d-43b0-87b7-f0f6e6e91fb3",
"db_currency_id": "316d78bf-6b68-4544-824d-5b5dd006ac6d",
"db_language_id": "ca66d25d-b870-4289-9074-09acc52c03ae",
"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-10-24T07:10:06.5826374+00:00"
},
"modified_dateutc": "2026-10-24T07:10:06.5826374+00:00"
},
"marketing_segment_id": "25462d31-401e-4f19-9073-c600df8fe738",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "44e48c3a-8a08-4d06-b1b7-9e437a04a0f0",
"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": "1c8045dc-b7d1-48ec-a425-a2ef3788a249",
"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": "b28cae21-4ec7-409a-bbd2-c70a5c515b80",
"db_country_code": "sample string 28",
"feelist_id": "7f778100-0d58-4b78-bdb6-da617f987e3a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f4011128-cdbf-43ff-8e24-5f09a882b0f2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6c78cde5-3997-4e00-a503-810b289dced8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-24T07:10:06.5826374+00:00",
"db_currency_id": "c915778b-5fe8-488a-a40c-4d1ffeeb4cd3",
"db_currency_code": "sample string 10"
},
"company_type_id": "a724e621-2d7c-4b75-9716-b549e97536f7",
"company_type_name": "sample string 32",
"company_type": {
"id": "d9756feb-83d0-4ac3-a506-0213c3be4420",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91769e31-1538-41ca-9ee5-74de964de517",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1885202f-cd24-4d30-a48a-80eb4fb8b5fe",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dc3e594a-f0e0-48de-afb4-3a7676008613",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "08fb7201-0b49-474f-95f2-fd119c1ec3ae",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0b052f40-f521-4056-8ff0-a70d35191aa0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-24T07:10:06.6013873+00:00"
},
"company_sector_id": "3002e687-b092-40e2-8dce-7adcdd0748ff",
"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": "0877ec83-9b51-4bf8-a66d-11e9cc5890e0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1b5ed996-81c4-4247-acb2-ef4de9e2fee2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f9576c37-a32c-4763-a493-4ede2785e741",
"account_manager_user_code": "sample string 56",
"company_status_id": "a4b3ac3e-9b2f-4d9d-99d8-ee86ca88d291",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-24T07:10:06.6013873+00:00",
"id2": 60
},
"db_language_id": "9fce1d96-4b21-451b-8b64-44c37e5f104d",
"db_language_code": "sample string 7",
"db_title_id": "75645863-4d71-44bf-a54f-3e632140003d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-24T07:10:06.6013873+00:00",
"create_date": "2026-10-24T07:10:06.6013873+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-10-24T07:10:06.6013873+00:00"
}