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": "1b40d83c-132d-46df-a5e5-f9113f49c4bb",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ac4c6f74-75a8-4276-93ac-beebba39552c",
"company_code": "sample string 5",
"company": {
"id": "dd8348d8-b698-4565-9484-5bba6201be04",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-23T19:41:48.8991316+00:00",
"sales_territory_id": "7f6ba7db-c4c7-4273-8065-94228f078f67",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "512ccc96-a55f-44f1-b5d5-8e669686d7e2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "75f12885-710f-46bd-8bf6-f368f4a3c6ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "16d9f5ee-6377-45cc-b380-86712ec94ac2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dad59e1-a293-48a2-8003-4ebdcf761da9",
"db_currency_id": "000742da-a178-41c3-b6b8-c6836387d790",
"db_language_id": "95208db3-23ae-4b75-8492-68705a339de2",
"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-23T19:41:48.8991316+00:00"
},
"modified_dateutc": "2026-09-23T19:41:48.8991316+00:00"
},
"marketing_segment_id": "6c4461a8-05b5-4a5b-919a-385124a28cfb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1ee38e39-bff6-4232-8423-cd0bb8e7e6dc",
"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": "02b3b1a9-a2f3-4a71-a37d-690d7ab42f99",
"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": "50b12c89-253e-4b9c-a3df-a0fd7ccbaa01",
"db_country_code": "sample string 28",
"feelist_id": "e21febbc-6a9f-461d-9324-15c48aa4fa29",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6b0a2eec-14d5-42f3-84a6-eeb2557598f2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bd2faf2d-7952-489c-8149-aa7d8764bad3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-23T19:41:48.8991316+00:00",
"db_currency_id": "fcc77691-a6cd-401b-a4bc-6ac1a5d903f2",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ea5a913-662d-4698-94f7-8553a39ecaf7",
"company_type_name": "sample string 32",
"company_type": {
"id": "fec1f2c3-7bcd-4540-af19-63abd25fac00",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3bb98b0b-93fb-4e17-a540-ec6a03047dd3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "69633953-3862-48bd-b852-a1860c62fb03",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "12badfd8-b7a4-46de-a008-85c2ff17b58c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2459a1c3-233e-42b5-a369-8b62dd6309dd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "888034b2-476d-4503-ae3e-0fdfefceb8f0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-23T19:41:48.8991316+00:00"
},
"company_sector_id": "27214748-dc65-4be2-8cd9-9d2119fa98fd",
"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": "45d9e9ec-01a0-4d61-94cd-021a366a16f2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "45ba8ef2-96e9-4f9e-9976-3c02e49f517c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "26dd306a-6d09-4b86-b81b-f792522f9451",
"account_manager_user_code": "sample string 56",
"company_status_id": "7f8395da-2cc8-44e1-9755-f04022105adf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-23T19:41:48.8991316+00:00",
"id2": 60
},
"db_language_id": "c762cf5f-cc1c-41fc-b82a-fb0ef66010f6",
"db_language_code": "sample string 7",
"db_title_id": "d3780db7-c73e-49ed-888a-e2b9602b564d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-23T19:41:48.8991316+00:00",
"create_date": "2026-09-23T19:41:48.8991316+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-23T19:41:48.8991316+00:00"
}