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": "1a419cf4-e89d-40bc-acfc-a118127824ff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "48046894-8b3a-4266-a6f0-b9f411a79b63",
"company_code": "sample string 5",
"company": {
"id": "497f888b-b0f5-480a-8ecd-0d455b6df410",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-13T10:57:24.5388508+00:00",
"sales_territory_id": "7efc73f4-1378-44f4-be5f-832e8c447651",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "884f32e9-6687-4bad-8f16-ecaa405e3f92",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36f82b38-61eb-49bd-9876-d790dbcc7201",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98f6dbad-0aea-4735-821c-6a75b908f5cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "100fbd48-86c1-419e-8b96-0de287ee9650",
"db_currency_id": "c1a0b9ce-583a-4ef4-92e9-a492f7d2b48a",
"db_language_id": "aa1f84b2-e752-4bc4-8d49-62ef9d1276f9",
"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-13T10:57:24.5388508+00:00"
},
"modified_dateutc": "2026-09-13T10:57:24.5388508+00:00"
},
"marketing_segment_id": "f5b445f8-eedd-4c30-b647-60af399ca133",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b777757-e8b8-48af-a59a-c77363650e90",
"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": "d1327e19-c3f7-4e7f-9385-049a0d987c39",
"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": "8629d2e2-9582-4a1f-b26e-e5f1136f1506",
"db_country_code": "sample string 28",
"feelist_id": "bc4200ae-07f6-4208-9ead-bec638dff9f4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b8c8fa98-faf4-44f4-9533-1d05fa2f1dc3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7180761d-3f54-41c5-93de-043faebaea78",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-13T10:57:24.5388508+00:00",
"db_currency_id": "473f2ae1-3589-4d28-812a-704506272706",
"db_currency_code": "sample string 10"
},
"company_type_id": "1b1c0d5b-caaf-45d2-a77d-38e6bef820aa",
"company_type_name": "sample string 32",
"company_type": {
"id": "bc2066b5-7546-4bc4-beeb-972340c40bb8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f8bab97-00e1-42bf-9f26-8bbb6f78a241",
"sales_organization_code": "sample string 5"
},
"db_language_id": "16638f86-bcdc-4fca-9c0a-4180a48bdc63",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d3198bb8-88f0-47ef-b3ae-95a628a8f32e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d42b7005-d728-4fa4-8877-c28c95416c5f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bfc35273-9548-4fce-a60e-167dc36ccbc4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-13T10:57:24.5388508+00:00"
},
"company_sector_id": "449783eb-b722-4bf1-92c6-45ef49354633",
"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": "04a035f9-51a4-4d08-81c0-f59f12c6d66b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1a16b0ac-4850-4da7-b9ed-9d9246bb39ed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6988869d-c43d-4dfd-bef7-3a2df7a47ef2",
"account_manager_user_code": "sample string 56",
"company_status_id": "64e92b9b-6810-44e4-9969-f9009d5d55dc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-13T10:57:24.5388508+00:00",
"id2": 60
},
"db_language_id": "986b9721-c365-49df-afc5-551255b9e9e6",
"db_language_code": "sample string 7",
"db_title_id": "7c852d57-88a6-46ce-ab07-88146e6ba7e8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-13T10:57:24.5388508+00:00",
"create_date": "2026-09-13T10:57:24.5388508+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-13T10:57:24.5388508+00:00"
}