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": "88122609-5152-463a-befc-4adc2dec985f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1c5b1159-6581-4a8e-90f9-d13cd3540132",
"company_code": "sample string 5",
"company": {
"id": "f8aa01ba-7c4b-4758-b1a0-68bcf0b8f3bb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T06:47:58.9552922+00:00",
"sales_territory_id": "254eb970-083c-439f-934f-6e8d30bea477",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "08d59d14-df77-400f-91fc-bccff0a05a83",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2f01bac7-ed8e-4261-88d5-a8adbd5579ed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8ff0b3c7-f040-440e-bd04-624ceb6b6295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b6fbd7b-6c6a-4fc7-80c3-3f2ae9bcb6bb",
"db_currency_id": "423359bb-0105-4be5-84f1-1fcf3906e27e",
"db_language_id": "4b850437-81bd-4b44-8643-46149cd3233d",
"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-05T06:47:58.9552922+00:00"
},
"modified_dateutc": "2025-02-05T06:47:58.9552922+00:00"
},
"marketing_segment_id": "8485890b-7c22-43de-a03c-f7c05864d31b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1f8cde70-bf0f-4e0f-be25-de2726f2a578",
"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": "902dc281-f1c1-4778-aa6e-17158eb7c93d",
"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": "bdc707e9-e129-4e60-a9f1-b51b50628572",
"db_country_code": "sample string 28",
"feelist_id": "01cb65d2-514f-4218-8208-066141e6466f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c4588a43-e9f8-4391-b73d-aee9dde59230",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5e3d83ed-9fa4-46bf-8a56-c68b3cc86e55",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T06:47:58.9552922+00:00",
"db_currency_id": "81155de3-33f4-4975-943a-c6bfb9523053",
"db_currency_code": "sample string 10"
},
"company_type_id": "f7c3eb50-8479-48ae-932a-63991c55ad86",
"company_type_name": "sample string 32",
"company_type": {
"id": "35534789-2b37-4a11-8a76-2368819ef988",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "83eafb43-e1a1-4c71-ac02-4c260d2c9126",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e08bbbe7-c6c2-4221-9c56-fe115b10ad4e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "31df10c8-d9a9-455c-af83-c7671105cfc7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "07b40619-0ded-4002-beea-7dbe31c1687c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f8991b45-19ee-442c-bb66-6aea6101c9e3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T06:47:58.9552922+00:00"
},
"company_sector_id": "f99610b8-6112-47e1-99d7-49ef89d6d3b1",
"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": "dbf92688-a04c-49bd-8bc6-f28d6d0ecd82",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "88a92acb-1115-4c1c-8195-84c0cec660c8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "202b95e3-f0bc-4c21-aeab-162165cd345f",
"account_manager_user_code": "sample string 56",
"company_status_id": "da32b1b2-3842-48ea-ae37-c01d9808fbeb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T06:47:58.9552922+00:00",
"id2": 60
},
"db_language_id": "49d5c175-a477-41e8-82b3-763b869d6e57",
"db_language_code": "sample string 7",
"db_title_id": "0a1fdaf7-a7b0-4e65-a616-e87a8578b0d1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T06:47:58.9552922+00:00",
"create_date": "2025-02-05T06:47:58.9552922+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-05T06:47:58.9552922+00:00"
}