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": "3f99b398-1b61-48fe-9b82-b9605cb08ec5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "33f02239-6a7a-4c42-adfc-3ac6e65c07ab",
"company_code": "sample string 5",
"company": {
"id": "e0da5158-bb66-4a76-845b-d0657d345483",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-20T11:11:37.7519626+00:00",
"sales_territory_id": "9e663975-5e03-4ee1-9a39-fb4f203f5a44",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ac6c83ee-0f99-471a-bd6a-d7b303f50a56",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5d8a4045-448f-4508-bc37-38766ca2c6ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8cb2ee1f-b4ba-4143-ba28-5af74138dd8d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5db3488b-f517-4b05-8f3c-eef01ad63dda",
"db_currency_id": "2aade357-1541-49b4-b745-b301dcdb1843",
"db_language_id": "19c04ca8-2361-4e12-9098-ab4d6b86e3ff",
"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": "2024-11-20T11:11:37.7519626+00:00"
},
"modified_dateutc": "2024-11-20T11:11:37.7519626+00:00"
},
"marketing_segment_id": "4bdefa7d-bfe3-46cc-9ebf-a2a2ea1eff67",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "56f3fbf2-7406-40da-b82d-df94c5f969da",
"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": "005369f8-1315-4254-b13d-a75cce4f75a6",
"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": "dbbb391b-c10f-433d-a170-fe258b8aabe2",
"db_country_code": "sample string 28",
"feelist_id": "2b1cf43c-44b0-4833-949e-a151a4af7ba7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1a12d333-a90c-45eb-a079-345132ca368a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "92f90c66-05c5-42e7-a2e8-34c781900f64",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-20T11:11:37.7519626+00:00",
"db_currency_id": "f531c214-e807-4a68-836e-2b57c45affdb",
"db_currency_code": "sample string 10"
},
"company_type_id": "73fad903-93f1-45b6-8d1f-1019638737a3",
"company_type_name": "sample string 32",
"company_type": {
"id": "d0ec142e-7142-4107-a8a9-d25029fa6449",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fea48c22-3be3-4390-a479-7a610f6ad04f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "49b2acce-f87e-4cab-89bf-66e05f1f5016",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "433b92b8-9719-4926-8e4c-4b70b6b0d519",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "76f4d818-b9f3-44dc-b66f-cbbd202d25ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "07cf57fb-3805-4d13-843c-574d98127998",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-20T11:11:37.7519626+00:00"
},
"company_sector_id": "24d7d7d5-ddf4-4731-a574-ec601b89ade1",
"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": "12b9fc84-1af7-42de-8778-11ee33ad2133",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0e78ccc6-c244-42e7-8db6-3651dbe4ef92",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aa51e3d0-4505-4707-b53c-bb1ff1e9b9c8",
"account_manager_user_code": "sample string 56",
"company_status_id": "b1b28b19-8194-46e9-aae1-2452e1ba061a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-20T11:11:37.7519626+00:00",
"id2": 60
},
"db_language_id": "f47a74b7-8c66-4f7d-b520-3e9af2b72c38",
"db_language_code": "sample string 7",
"db_title_id": "0b7bc61a-6ba9-49e6-878b-79a35619da4f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-20T11:11:37.7519626+00:00",
"create_date": "2024-11-20T11:11:37.7519626+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": "2024-11-20T11:11:37.7519626+00:00"
}