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": "bd8ebdc7-faaa-4113-94f7-bca26a6a1336",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4573a770-23a7-4859-9c72-f37f6a36fb6b",
"company_code": "sample string 5",
"company": {
"id": "69c90c2a-815a-4506-a80b-12b09a226862",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-03T20:08:17.5004326+00:00",
"sales_territory_id": "3b1165b0-4915-4278-9f58-bcca37db9288",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f9400339-181b-40e5-bd63-484ce8bc3cf1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c49bbe5b-afca-4991-a51a-7dda464a06f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "723d0f6f-06bc-4f44-923e-e3a3954543b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30209753-8068-473e-ab4c-67a872e42de0",
"db_currency_id": "93d7efdd-8182-4e50-a32e-a1758b8e4761",
"db_language_id": "972c426c-f169-4c0e-8779-b340d481ca34",
"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-04-03T20:08:17.5004326+00:00"
},
"modified_dateutc": "2026-04-03T20:08:17.5004326+00:00"
},
"marketing_segment_id": "5305591d-b343-4cba-83b9-83d13d8da604",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "908fc0f2-92cc-4478-8676-85bf7dcf20d9",
"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": "974dbd32-65be-4804-bbf7-c97c4df90fb6",
"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": "01924df3-e5c3-4080-bfd5-47660c1d7257",
"db_country_code": "sample string 28",
"feelist_id": "2c09d838-e5aa-46ed-9656-f60e642d102e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a7ce4b5e-ff5f-44b9-8a04-248b381c18fc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ee96c68c-cd09-40a5-8cbb-91dcbbf0f1f6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-03T20:08:17.5004326+00:00",
"db_currency_id": "5ad758c0-075a-40cf-9664-331797a49445",
"db_currency_code": "sample string 10"
},
"company_type_id": "06284a58-5dd6-41cc-b6be-16402a16b6c5",
"company_type_name": "sample string 32",
"company_type": {
"id": "de180488-df70-4e44-b8e6-9431b70eb9c8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5f8d75a-84d1-45e7-97f5-45252cfd0b4e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8fb56428-5924-4123-8de6-5efe47783035",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "835d40c6-14b6-40e3-99d0-bdf152f72477",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e4c9dc82-6e15-4a91-8e77-52e388c92f52",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "04981942-f98f-437b-a393-6dd3c560d4f8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-03T20:08:17.5004326+00:00"
},
"company_sector_id": "491b4863-ef35-4236-9deb-96c10cbc06dd",
"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": "1c9805af-f71c-4a6f-a0b8-8077464d58f4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "61a2413b-21f2-4827-97de-ffe2daa63207",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5d67c00d-8e88-479f-85c6-f00e1d5f54d2",
"account_manager_user_code": "sample string 56",
"company_status_id": "218a9af2-81af-4f22-b075-e55eaf72c58a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-03T20:08:17.5004326+00:00",
"id2": 60
},
"db_language_id": "72318ed7-382e-4eb4-9852-c059e912dce2",
"db_language_code": "sample string 7",
"db_title_id": "44d73d63-2907-4015-a940-87dd2bdecb64",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-03T20:08:17.5004326+00:00",
"create_date": "2026-04-03T20:08:17.5004326+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-04-03T20:08:17.5004326+00:00"
}