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": "69e2517e-c28c-4eca-9518-a0580a49e183",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5417b61c-1286-4209-91f5-7849813f18c7",
"company_code": "sample string 5",
"company": {
"id": "3efbfb43-4f75-47b1-ad23-4f145df62fd2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-12T04:15:16.2789254+00:00",
"sales_territory_id": "6bbcce10-6b9c-4f72-98d5-8a5559b4663c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "32b9fe47-b1cf-4873-80b7-f319b795a796",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d62087d2-b210-4c6b-9f73-e3a7f1c40bf4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4dbb5596-6e47-4703-950c-da26ea66f324",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fc0973bd-752d-4345-a90f-5bf1e06faf45",
"db_currency_id": "4cd3de5f-467b-4928-8d7a-4196d939a0de",
"db_language_id": "db69b122-eb48-4482-a05b-82a1766a4eb2",
"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-05-12T04:15:16.2789254+00:00"
},
"modified_dateutc": "2026-05-12T04:15:16.2789254+00:00"
},
"marketing_segment_id": "b797af52-dc2b-4a9f-87a3-a790559a5a9a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "72e341cb-45a1-4c23-a8a0-182f1afe6fc0",
"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": "86b66ee7-3ca0-4846-b916-3a9ece0a8b9f",
"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": "0c10c7e4-2aa6-4add-a2a8-e79ad8383ba7",
"db_country_code": "sample string 28",
"feelist_id": "680fea51-3d74-40ed-b6e7-e8b94cc21cde",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d0142e68-04cf-4ae3-87fa-2a0cbca8c40a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e2d5d348-9ee7-48c6-a207-5a324afee048",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-12T04:15:16.2789254+00:00",
"db_currency_id": "f6818ee9-d659-483f-a8c6-0b409027a432",
"db_currency_code": "sample string 10"
},
"company_type_id": "e2294cc7-5022-4ce7-8517-a9b4592f2e13",
"company_type_name": "sample string 32",
"company_type": {
"id": "c5d8f1a3-b954-4c6a-96cf-f966b69fd28e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "080b5a35-774e-464f-a7d6-c5ab9792629d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "34682120-0fba-4325-95d9-a1e11785947b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ec48e14a-8ee2-470e-8491-0f2e7d78e87c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "aaf76d9f-7916-487a-8757-9c0e88d682df",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "688a4afe-4ad2-44c4-8679-d0bfb17a142b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-12T04:15:16.2789254+00:00"
},
"company_sector_id": "72c4ab85-74fc-4f58-b4b1-52ddf8ba97ac",
"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": "7c80f4cf-cb59-47d6-b201-c62edc73f6f8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "54a1b3b3-6049-439b-847a-ead54a0cd519",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "64fc0a8c-cc6a-42d1-b219-6ffbf170d708",
"account_manager_user_code": "sample string 56",
"company_status_id": "835d178f-bd0b-42f7-8ff9-97649aea79d1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-12T04:15:16.2789254+00:00",
"id2": 60
},
"db_language_id": "1f50d5b7-0d9c-47e2-b6a0-59802e67fc4b",
"db_language_code": "sample string 7",
"db_title_id": "8334e77e-3e9f-4dbb-b5ee-24ee16405152",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-12T04:15:16.2789254+00:00",
"create_date": "2026-05-12T04:15:16.2789254+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-05-12T04:15:16.2789254+00:00"
}