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": "49d2d897-437f-41e0-b57b-8b211ff2a69e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "45d1499d-4a9b-44af-b69f-7d95e696cbbb",
"company_code": "sample string 5",
"company": {
"id": "dba3cd8e-b579-4a62-a4de-0a481bfe15a4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-23T02:47:39.3121161+00:00",
"sales_territory_id": "60607c05-8fe9-4e5d-9543-6f73686948c8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2baf47e0-89e9-419a-a365-18b0fe138cc5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d41759b-e2df-4716-9253-5a37438f61ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a32891fe-1c97-43a9-a9db-0822574cff8c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ae507ac2-612b-48db-9c96-014e87475bda",
"db_currency_id": "188f4586-92f9-404d-bcac-80d51f9bd5b9",
"db_language_id": "eebc5a15-1b2c-41f9-bd7f-1ee1a7255310",
"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": "2026-09-23T02:47:39.3121161+00:00"
},
"modified_dateutc": "2026-09-23T02:47:39.3121161+00:00"
},
"marketing_segment_id": "d8b42c25-3a42-4674-9112-988b82bb343c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1bfadafb-5311-4d5c-aeb6-900ac626c681",
"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": "bd026d5a-c9ff-491d-a4bd-24ddf9baef73",
"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": "a7e29fd6-2dc1-4b0c-acdf-6eb30811fd35",
"db_country_code": "sample string 28",
"feelist_id": "31b0d71e-febe-4e45-9b99-d27057c3ef93",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4ba11c58-7aa3-4385-8379-081f493acf14",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1de8ca9e-fd19-4cad-9e8e-e00fcc94216e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-23T02:47:39.3121161+00:00",
"db_currency_id": "67073f6c-ebb8-48ee-b3f0-9628b5442089",
"db_currency_code": "sample string 10"
},
"company_type_id": "fea14f0e-275d-459d-8753-789f701d9353",
"company_type_name": "sample string 32",
"company_type": {
"id": "8175f1dc-94e2-49f0-9636-a4fe53a0b2e4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28aa54a4-690a-42e6-afc2-af2ab120b660",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1add3be0-2e16-47fc-9db1-7b1db350bca4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "030dc33d-c60f-4a8c-8cf3-a015a291fdfc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bc0210d4-cc1d-4754-8762-6e95343aa802",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "71646659-13aa-4d66-8944-1bb81344b1d2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-23T02:47:39.3121161+00:00"
},
"company_sector_id": "7bf2fdbc-ce70-4537-b3cd-03bc5925035b",
"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": "00aad079-80a3-490e-aa6e-c2057e9084e7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2984a5b7-98c7-49e8-8fc6-5a0fa82b7750",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "de9fd056-9e76-4198-8d10-bb0ad8c05d80",
"account_manager_user_code": "sample string 56",
"company_status_id": "a6b99439-5a7d-49a4-a7bf-f65e5ec0ddd5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-23T02:47:39.3121161+00:00",
"id2": 60
},
"db_language_id": "a38cbcf7-7638-4b96-9faa-f4a1c78febcd",
"db_language_code": "sample string 7",
"db_title_id": "1416b8c0-a5cc-4a9e-8b29-acc8fefe433a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-23T02:47:39.3121161+00:00",
"create_date": "2026-09-23T02:47:39.3121161+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": "2026-09-23T02:47:39.3121161+00:00"
}