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": "2a286f0f-d4f7-4fad-9bed-356a00bf705c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d0045454-157b-49ca-9913-d23bc990bc9d",
"company_code": "sample string 5",
"company": {
"id": "079f854a-39af-456e-8091-c53e80c3f19d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-30T05:19:36.6144446+00:00",
"sales_territory_id": "e4b9cff8-a5dd-4c25-a036-47175c45c86c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fea55f49-05a5-4f8e-9e98-24e6d3819314",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b23a443-1499-4e04-af90-af319dd6ff65",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d155ad70-d347-4ed6-85e2-a04c1e0ba932",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "32f98291-24f2-42b4-ae73-295d5c851aee",
"db_currency_id": "084790dd-ca29-4bd8-8752-8b46156a5441",
"db_language_id": "99f21c6c-b013-45bf-92bc-becfdc6d3284",
"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-08-30T05:19:36.6144446+00:00"
},
"modified_dateutc": "2026-08-30T05:19:36.6144446+00:00"
},
"marketing_segment_id": "df72a7f8-0794-4a86-a244-0614294bf61e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c8404d61-06d3-4997-8f45-7e960d2d69ae",
"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": "1bdd2dc5-574f-4881-8229-20ea9da81edc",
"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": "ab085747-f168-4b70-ac84-e8213b5d6a95",
"db_country_code": "sample string 28",
"feelist_id": "9804c6fc-5d65-4008-992c-64c613dc2e39",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6e14561c-f8ea-4a5b-a215-3f020defef3f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a85ccfb3-3c16-4742-98ff-90dc65b34f3d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-30T05:19:36.6144446+00:00",
"db_currency_id": "aed88d03-b7d5-4df0-8439-e938aadd9e78",
"db_currency_code": "sample string 10"
},
"company_type_id": "5efee93a-2db7-4e5a-908a-cbab377b3e3d",
"company_type_name": "sample string 32",
"company_type": {
"id": "0658e442-08d4-4351-bc1e-6f3f4057bce5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7ca34b94-7f3c-4c50-aeac-7ab8a77ad003",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4ead6c7f-272e-4611-8622-524e2b96bfaa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "57478c74-bd47-4149-904b-bd697325eae2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3bfd89b2-73cb-4e3f-b985-556bd1500219",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a68ce9a2-5285-414a-a121-6682b15b49ca",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-30T05:19:36.6144446+00:00"
},
"company_sector_id": "ba5789c9-750f-4968-8a98-a80b323cf72d",
"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": "3469a489-cca5-4018-b7b4-4262c9dea33b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "371bf54b-49e1-48c0-8c71-fbd13e3808e1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "525b0811-8a37-47d4-987f-cb1ba07ce612",
"account_manager_user_code": "sample string 56",
"company_status_id": "b7d09a26-4a15-4dfa-9c51-75e88e0a232d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-30T05:19:36.6144446+00:00",
"id2": 60
},
"db_language_id": "12fccb98-b3e6-4a33-aaf8-337fe47a31c7",
"db_language_code": "sample string 7",
"db_title_id": "abdc4936-10b2-4745-bc25-b45258f5befc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-30T05:19:36.6144446+00:00",
"create_date": "2026-08-30T05:19:36.6144446+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-08-30T05:19:36.6144446+00:00"
}