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": "633a0ab2-de81-456a-a5fa-b875778c27be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "39655d01-6727-46a8-8057-e8fa38d09001",
"company_code": "sample string 5",
"company": {
"id": "97a7fdbb-7c82-432d-ade5-57fb3823be7f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-19T09:41:00.8388631+00:00",
"sales_territory_id": "e1168181-72fd-476e-8d8c-ae7c1ca7de21",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4b271780-d434-4795-a1d7-49a630b22774",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2f8f256-fcfc-4a72-9588-e8c1f48b25e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "07691345-0e51-48da-8fbe-0ecea7c6749b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "19447717-f6d4-44c1-8f10-58dddaa986dc",
"db_currency_id": "4309ac72-c011-4de8-9715-d7950ff334f3",
"db_language_id": "47a2a45e-269e-4353-a56b-fb7c42068826",
"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-02-19T09:41:00.8388631+00:00"
},
"modified_dateutc": "2025-02-19T09:41:00.8388631+00:00"
},
"marketing_segment_id": "053f2360-a109-42c6-b5c5-7930a33830f7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "49bdb148-b001-4105-bf1d-294ef65b0375",
"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": "0133d423-ae9d-4785-9737-229f2372edc8",
"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": "6f4f5e58-895b-4b64-a88f-ea3a7f0757a1",
"db_country_code": "sample string 28",
"feelist_id": "ef1bf814-bb13-4c27-8907-7f91e53870ae",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c3c86c25-2545-46fd-b6a7-7012edf525b7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "496fb0da-4805-4ecc-ac41-993df21a58b3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-19T09:41:00.8388631+00:00",
"db_currency_id": "4a59bb42-e14b-4153-a4fe-f3d72116f69f",
"db_currency_code": "sample string 10"
},
"company_type_id": "3e2304d9-60e1-4eb3-9404-a0ec501d8096",
"company_type_name": "sample string 32",
"company_type": {
"id": "fd0d8618-079d-4320-a2d9-be25efa5b925",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8023e5f6-dc27-4642-a32a-96475b0ad6ee",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eea89342-13cf-4e4c-9467-998924434b1c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8aa0ea8f-5be6-484a-8b20-18b273df6c7a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fcdb2324-0dc4-4ffb-b492-4f8ff12fcb7e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "629db372-ae20-48de-8b86-ce04c6547a3b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-19T09:41:00.8388631+00:00"
},
"company_sector_id": "8d091b62-f6ae-4380-8851-20026126b5ab",
"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": "612aa258-562b-4f21-8337-088f2064d743",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6e4c6955-2c8c-4898-875a-c98abcad66ef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "521e35a1-e459-4758-b9b1-9bd91592a694",
"account_manager_user_code": "sample string 56",
"company_status_id": "21e94d86-367f-4b68-b8db-d47706e55282",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-19T09:41:00.8388631+00:00",
"id2": 60
},
"db_language_id": "c2e73b11-df2c-4096-93f9-567c38f080d6",
"db_language_code": "sample string 7",
"db_title_id": "70a49f9e-1508-4b08-8eab-7e2df9026737",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-19T09:41:00.8388631+00:00",
"create_date": "2025-02-19T09:41:00.8388631+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-02-19T09:41:00.8388631+00:00"
}