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": "9381a187-294a-4ed7-b047-f6371d5d68a2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2e6776e5-fbbb-40f3-8744-998b449e03ee",
"company_code": "sample string 5",
"company": {
"id": "a14d94c5-c898-4af8-8afd-51a19d1b07cc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-10T06:26:16.2133906+00:00",
"sales_territory_id": "f12d93e0-fea1-4dbc-b0cf-61ef7671c34d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "858c70c7-ea25-4b00-87f6-abfcfe119635",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1163613c-fa42-45c0-80c4-b3cee2accff4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5bec70b-11b2-421e-8ebb-fee6243f2c8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09b2c666-e818-43e8-a074-63375ced4820",
"db_currency_id": "b72eaff9-8717-4ca0-bdfd-12862337534f",
"db_language_id": "3efa5f28-a158-4a9b-a91e-6ac4c3d5fce7",
"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": "2025-12-10T06:26:16.2133906+00:00"
},
"modified_dateutc": "2025-12-10T06:26:16.2133906+00:00"
},
"marketing_segment_id": "7ff63bbc-87dc-4a86-9dae-4247183b79ac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6de8861b-a6f9-49b3-97d8-8e4524617869",
"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": "26463ff9-1a23-4a8f-acc5-da3e5a82bf68",
"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": "c1a877da-0468-4c51-b4af-f42edefc4e3c",
"db_country_code": "sample string 28",
"feelist_id": "99930912-41b0-4729-b3ad-0ea3907b1ca5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1cfb81fc-d63f-4f46-a72d-43076ca919c2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a206912-c938-4d19-9f5f-0219b61c3f70",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-10T06:26:16.2133906+00:00",
"db_currency_id": "22aa9bb4-a49e-4887-944d-2c8af403df34",
"db_currency_code": "sample string 10"
},
"company_type_id": "4190281e-e3cf-4412-b364-4bd30264a6d6",
"company_type_name": "sample string 32",
"company_type": {
"id": "b6e7546f-769c-4f7b-a1b3-79ec31c20b7b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "91d2898c-d5f1-4b74-9e53-d3775fa69d91",
"sales_organization_code": "sample string 5"
},
"db_language_id": "def3dc51-84bf-4110-92a8-e46b17756d5a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e7670139-0050-404a-8a39-6427af8632a6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "027fd7d6-9f79-4870-8749-55a8574a8f0b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1c287c73-7f2e-4d16-b9ca-c9c7df254210",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-10T06:26:16.2133906+00:00"
},
"company_sector_id": "c6c4167d-657a-4482-9235-f63c413a21ba",
"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": "c18c945f-2c5f-4a71-8de6-683d5c7eb951",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d7612636-64e3-40e2-a568-94b4a53e2f30",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d7914bda-a1f3-41e3-bc13-ca0cedc9bde5",
"account_manager_user_code": "sample string 56",
"company_status_id": "6bd46eda-4461-45c2-98d5-f2aff1e1ebfd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-10T06:26:16.2133906+00:00",
"id2": 60
},
"db_language_id": "a42eaeb2-36f6-483b-84a9-1688981fe4e0",
"db_language_code": "sample string 7",
"db_title_id": "f048f650-4b90-45b4-8438-09962bab8239",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-10T06:26:16.2133906+00:00",
"create_date": "2025-12-10T06:26:16.2133906+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": "2025-12-10T06:26:16.2133906+00:00"
}