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": "3f519548-fb53-4408-86d2-c911e15f38ba",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dad02bba-c0c0-4e42-a112-3ad418bd8487",
"company_code": "sample string 5",
"company": {
"id": "b5e1b811-16bb-43de-8aba-57b5ceb34599",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-24T17:36:14.0240424+00:00",
"sales_territory_id": "66646c59-8577-40de-9f4a-0f7c161268ce",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a7c2ee21-b1ff-4b2a-94f2-3358b10269b1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2419500d-33a6-4a1d-b947-4fc8d98a1329",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "27575515-98b8-4d3c-89ad-ee6f11ec77a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "847e5c54-0dce-48d5-b265-20e53b86d31a",
"db_currency_id": "47aa572e-1867-4b29-9433-e123c92da30a",
"db_language_id": "0226a88b-6dd0-41e2-a4c9-eecec3b567c5",
"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-24T17:36:14.0240424+00:00"
},
"modified_dateutc": "2026-07-24T17:36:14.0240424+00:00"
},
"marketing_segment_id": "739307f4-7c00-48cd-a14a-5fcb8ebd8889",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "276c85c1-67f5-4381-b79e-50778c94563e",
"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": "62488ed9-29df-446e-808b-6bd615654313",
"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": "e5f934e6-2771-4470-a845-887092142dc4",
"db_country_code": "sample string 28",
"feelist_id": "c3891278-1501-4588-a083-2763b8baf5ea",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "61c248c0-cd57-4aa7-bd8e-09715d1396f5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "509d0c61-6d6a-4161-ae2a-47ab29681b9e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-24T17:36:14.0240424+00:00",
"db_currency_id": "4af63868-02f0-43ee-a5a0-ed67cacd18c7",
"db_currency_code": "sample string 10"
},
"company_type_id": "20eb24f2-6ebb-4e28-ad3b-17c0b9eae522",
"company_type_name": "sample string 32",
"company_type": {
"id": "a51a8291-8286-4e0a-913e-278e28dde8f6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4d469c3-4c90-44e3-a558-a32e84a63293",
"sales_organization_code": "sample string 5"
},
"db_language_id": "30a48a56-620b-477b-a3a3-d7c0d5677a92",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "072210cd-b876-4b17-ad8b-4dd54e8ef506",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cb115c72-1bc3-4c2e-b1a7-06dd02309ecb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8931f8a9-d964-4b02-b3d2-0c71c07e69ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-24T17:36:14.0240424+00:00"
},
"company_sector_id": "fdf3e7f5-50c0-4ed2-a663-f3eb8a8cf042",
"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": "82d72a04-db70-483e-b891-22e120fc0c09",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c3a5fc07-57d7-4155-9ab7-bbadfafe2dde",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "25c33660-7e1d-4d3d-b10e-db3549486a25",
"account_manager_user_code": "sample string 56",
"company_status_id": "f643e5cc-29bf-404a-b281-4badd79eed76",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-24T17:36:14.0240424+00:00",
"id2": 60
},
"db_language_id": "b5096b3e-53ce-4325-a048-37705ce5c1a4",
"db_language_code": "sample string 7",
"db_title_id": "305bf226-4e74-46c9-b29d-0aa54801305c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-24T17:36:14.0240424+00:00",
"create_date": "2026-07-24T17:36:14.0240424+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-24T17:36:14.0240424+00:00"
}