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": "8d059fed-fe1f-4825-9230-4b5a7af2aa37",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a3b93b08-8b4d-40fa-81fa-bc8ed194ac71",
"company_code": "sample string 5",
"company": {
"id": "37a72bf5-146b-48e7-8baa-aa8cb6d879cb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T14:35:30.7953159+00:00",
"sales_territory_id": "dd619b5f-e3b9-4881-a122-5a86e91dac9c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5557b418-a0cd-472a-9e1e-c361ee3f6568",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa70c812-5594-4553-ae11-3d8b1477d182",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fed4183e-cca0-4265-a30d-c325fba169b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1679b05-ce30-4952-b15b-3976e6cdce54",
"db_currency_id": "7db07a46-5f7d-4bb0-a5ea-57c9977b4c89",
"db_language_id": "f2d007dc-ac3d-4bab-8420-f30c4e51e92a",
"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-09-04T14:35:30.7953159+00:00"
},
"modified_dateutc": "2025-09-04T14:35:30.7953159+00:00"
},
"marketing_segment_id": "161d3f4b-c963-44e7-bcb4-4aaa7dfc0fc2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7c8ffdcf-aac8-4500-98cd-9a2cd9a5b43e",
"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": "c149220f-9439-4d3c-a721-279ad36c3aea",
"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": "d2cb6065-5b59-422a-9242-218e0997fd62",
"db_country_code": "sample string 28",
"feelist_id": "1b0607f2-3a2a-47c7-9644-c4bb179f9976",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "47d427bf-d91b-4193-932f-aa080211c2ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cc036cc3-fddf-4c46-ad9e-16909c29c3a7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T14:35:30.7953159+00:00",
"db_currency_id": "1bfe1eeb-5f2b-485d-bd70-1e8a39ae0ff9",
"db_currency_code": "sample string 10"
},
"company_type_id": "75b33786-216c-4af1-9211-84bd57417f66",
"company_type_name": "sample string 32",
"company_type": {
"id": "4e5abaf7-071d-4546-b5b9-64e4d05143fa",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d75e17aa-a94c-4a88-a768-5c1a35c42e90",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bed4125b-a265-4c12-beca-c11663956d20",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "87e9ce61-f6cf-4167-b522-1f9840788e67",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "451e1923-f415-4ec4-9b0f-3832a497d05c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "069a440d-b3cd-4aaf-bdb2-8bd5e2b5fbc8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T14:35:30.7953159+00:00"
},
"company_sector_id": "c598d980-1dae-4495-9aee-1fadd80e2078",
"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": "6946ad62-5fc5-43e7-953c-b2378d3f8693",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dd35c285-950c-480d-bbc1-1c096edc71d6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "47ab4147-3779-48fb-b9cb-9181055ae07c",
"account_manager_user_code": "sample string 56",
"company_status_id": "b61cba71-c290-409d-82e5-3f78534f2c80",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T14:35:30.7953159+00:00",
"id2": 60
},
"db_language_id": "62bd39bd-4178-407a-8742-3621c8337a36",
"db_language_code": "sample string 7",
"db_title_id": "79136769-4e17-4106-9380-0edc3bee94af",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T14:35:30.7953159+00:00",
"create_date": "2025-09-04T14:35:30.7953159+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-09-04T14:35:30.7953159+00:00"
}