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": "b30b1bec-3e4d-4c89-8b90-2dba6078f88f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "871e6b9c-b539-4d28-af92-ed64d3fa06d1",
"company_code": "sample string 5",
"company": {
"id": "06aab5b0-ab4d-4912-b6bd-5a386d52232c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-28T13:12:55.4052806+00:00",
"sales_territory_id": "8163127b-9b3c-485c-8f9b-f239dc3f6a9e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "65c82311-54f9-4c6c-886a-1126022fe13b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5938de45-8efd-4af8-9556-594e6f99396a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c3668e4-3de2-4219-8163-08450df37307",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf04ba69-8dbd-471c-84fb-7900cbe50387",
"db_currency_id": "cc950a36-e80a-4d2c-ba0a-cb764014726b",
"db_language_id": "72c760c6-b8ea-4609-90ef-c5ad8a013d6c",
"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-03-28T13:12:55.4052806+00:00"
},
"modified_dateutc": "2025-03-28T13:12:55.4052806+00:00"
},
"marketing_segment_id": "9ff8119e-e7a9-492e-b2c3-49d80fce238a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9c9bc515-9c5e-4ee8-864d-acdbdfe38588",
"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": "c029f56e-c76f-4101-827e-ab2ec337d3d2",
"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": "6154336b-8661-4e35-bdb7-b0867a432d35",
"db_country_code": "sample string 28",
"feelist_id": "c03f0ec4-bf18-4d23-a657-6e56e809be43",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "50e880c5-469b-41f6-915c-128cf1a474bc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3e355bd3-10e9-4084-8180-675f30d87f26",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-28T13:12:55.4052806+00:00",
"db_currency_id": "5dbbc081-c0a6-4137-a15f-9cf6a4114fe9",
"db_currency_code": "sample string 10"
},
"company_type_id": "fe16f06b-63d0-4ae0-9116-0c1e169e471e",
"company_type_name": "sample string 32",
"company_type": {
"id": "48d2bc1d-54e0-4b81-a34e-4bd83edffca0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a7b5bf5-4ac5-47e2-a514-e8a31c7e24cd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d55adac1-99cb-4bde-98be-b3339b57f9be",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9de18e1f-d224-49b0-86ce-a31a7887f1d0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5c559446-2c3d-4cdd-b127-ca16ed4e280c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "11067d88-2cb5-4843-8b18-389597cd5972",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-28T13:12:55.4052806+00:00"
},
"company_sector_id": "e69178ae-dea2-4d96-94de-187f869549fe",
"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": "9bc7a027-acba-4e10-9d3f-716a9a37b7d4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "55b86e5d-344d-4ea2-b710-d7c4e7b18ae8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3e7ab0c3-15eb-4799-9764-6003e7b32442",
"account_manager_user_code": "sample string 56",
"company_status_id": "a3e70979-d78e-4a73-874d-88e7b9c258c1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-28T13:12:55.4052806+00:00",
"id2": 60
},
"db_language_id": "774f545d-2457-4127-b531-751578f70bda",
"db_language_code": "sample string 7",
"db_title_id": "a5aff75b-b2d3-49a8-814d-d05f54bdafc2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-28T13:12:55.4052806+00:00",
"create_date": "2025-03-28T13:12:55.4052806+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-03-28T13:12:55.4052806+00:00"
}