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": "b308da7b-4e13-43c8-965c-55b513bdb9a6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "73850f9b-fc4f-4e00-8d4f-73d3b392b8c8",
"company_code": "sample string 5",
"company": {
"id": "5df1dcad-8317-47b1-9121-25d3409f0c0f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-22T01:13:34.5281552+00:00",
"sales_territory_id": "522224c5-dcde-46bd-9b62-89cf3f6dc3d2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "60fd0fe1-1282-4c5f-bcb4-f1f513c84959",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "50a8034c-cf1b-41e4-b7d8-e46b64a50b7b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef2b0a53-7a00-47df-b2d5-f4da9831c26b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "629b937b-2739-4ed1-a704-8fc64a52cace",
"db_currency_id": "83e32859-d5b0-46e2-8f69-226fa6a06dfe",
"db_language_id": "509f4b8b-3805-489c-9001-c014facc249d",
"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-01-22T01:13:34.5281552+00:00"
},
"modified_dateutc": "2025-01-22T01:13:34.5281552+00:00"
},
"marketing_segment_id": "4d1ed49b-235f-4bb2-bf1f-667a76f0546d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a12375c9-d44a-45cd-8c2b-5f85ecd4fadd",
"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": "072b7068-ba19-41b9-87ff-780142012fc3",
"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": "82bb1569-5c7a-41b9-9339-8bf39864a1bc",
"db_country_code": "sample string 28",
"feelist_id": "794f0696-5df2-4441-a37e-c428fb62d185",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e2e7e9b0-be6b-461f-9176-ff72d6cba6b2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e5632622-d281-4657-bdfe-ae780fbcc776",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-22T01:13:34.5281552+00:00",
"db_currency_id": "76356e57-39bf-446f-b67f-ad7842df9311",
"db_currency_code": "sample string 10"
},
"company_type_id": "aeaec1be-0df6-4e5d-a0a7-6dae4f08afe5",
"company_type_name": "sample string 32",
"company_type": {
"id": "baa4172c-b43c-456b-b99f-bee9462851f3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2fd6dc98-9603-4aea-9977-a99b95a400ad",
"sales_organization_code": "sample string 5"
},
"db_language_id": "185e393d-3cc1-465f-8805-ac359383bebc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "99942e6c-7e2f-4e81-8e4a-58f89b7b56a7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "12c3a1c3-25a7-47da-8606-65cbba87b770",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b4e89a4f-2131-42b4-ade8-94ba038d834b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-22T01:13:34.5281552+00:00"
},
"company_sector_id": "cfc7f6e7-623b-461d-810d-5e294346bc37",
"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": "dfaaa72a-540a-4051-bc9b-3ff791f8c748",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d9082c69-009b-44cd-825a-382cf179c00e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3a2b0169-b158-4661-94d3-114699366e98",
"account_manager_user_code": "sample string 56",
"company_status_id": "6e95153b-a65d-4ebb-a33c-45a96ed120ad",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-22T01:13:34.5281552+00:00",
"id2": 60
},
"db_language_id": "a7c2abcd-0fb4-4838-83dc-09adb7e5907a",
"db_language_code": "sample string 7",
"db_title_id": "6c5559dd-6010-4046-8ff8-ae5d8bb888f0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-22T01:13:34.5281552+00:00",
"create_date": "2025-01-22T01:13:34.5281552+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-01-22T01:13:34.5281552+00:00"
}