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": "36cbde12-61c7-499e-8548-81671e80eb86",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4bec3ebd-3f20-48fb-a87c-17c44866f73d",
"company_code": "sample string 5",
"company": {
"id": "cd0e2414-a17d-45f2-bf3a-f6623257b300",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-16T11:37:24.6638698+00:00",
"sales_territory_id": "da9c4de6-e729-4e1e-b7ae-573b417983c9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "41f7c8bb-2696-4699-aa11-2a370a4108a4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "604df7cb-767e-4517-9810-966d595b281e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a44940a-0036-469f-b4c3-e3c1d8f2256b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c2372b85-223b-4a0f-8633-ad4c68e8c45f",
"db_currency_id": "0ad0949d-606d-4537-baed-6730249677aa",
"db_language_id": "93f4a87d-ee90-4120-8d2c-fdddbb377ac9",
"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-12-16T11:37:24.6638698+00:00"
},
"modified_dateutc": "2025-12-16T11:37:24.6638698+00:00"
},
"marketing_segment_id": "f38e94b2-4851-4b3c-bad7-51fb15820ddd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5175eb59-27c3-4008-80aa-f41d2854e3c6",
"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": "dcbe776a-428c-4294-9a35-ecf4dc276463",
"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": "e4c43117-9daf-40e5-8ffd-017a09aef72b",
"db_country_code": "sample string 28",
"feelist_id": "74698c28-4ad8-4ba1-b1c6-6b342dea2f5a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b3909193-5dcf-46b4-92e9-052135741070",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2c9aab58-6bfb-407e-b46b-77edf3ed4d0f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-16T11:37:24.6638698+00:00",
"db_currency_id": "97215dd7-a15b-4660-b0f9-3da2f3e3af2d",
"db_currency_code": "sample string 10"
},
"company_type_id": "507ab7c7-be70-4fd0-91e3-22b315f17ce9",
"company_type_name": "sample string 32",
"company_type": {
"id": "69bc07a2-0d46-4904-b221-71dff5c43b19",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8eaf5ca1-6313-41d9-8d1d-f94131c0d495",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bc8bb6b2-670d-42d7-91f7-b36141c74d3e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ce57a1cf-eebb-4b8d-9ee5-3cd6298bb235",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2e2f3adc-0f95-4878-a7f4-4e88734a631e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "74ee9b5e-3c32-42e0-95a8-6853a8919cc1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-16T11:37:24.6638698+00:00"
},
"company_sector_id": "d8a444e2-b076-4b14-9900-7be212d9f2c9",
"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": "ec34e13d-c324-4791-9e6e-7bc9afd00788",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dc9a8901-e9f2-4035-8722-91e7757d2533",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "45e45951-5b08-4fad-b4b4-c0a348459573",
"account_manager_user_code": "sample string 56",
"company_status_id": "728685c1-6fa0-4f66-961d-d88c9d07cead",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-16T11:37:24.6638698+00:00",
"id2": 60
},
"db_language_id": "930ba540-40ff-4ce7-a5b9-29eb736e44d9",
"db_language_code": "sample string 7",
"db_title_id": "8023f4c4-239c-4aec-8fd6-b5c0dad513a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-16T11:37:24.6638698+00:00",
"create_date": "2025-12-16T11:37:24.6638698+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-12-16T11:37:24.6638698+00:00"
}