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": "88fef95a-86f3-4c78-97f8-ca473f51f042",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ecf0993b-2f70-4e96-a687-f597a90ce922",
"company_code": "sample string 5",
"company": {
"id": "f5ccb0a3-b337-41f4-b2e8-aed47de397bf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-16T22:44:51.0085781+00:00",
"sales_territory_id": "37849b93-8fc8-4b40-85a4-9647e90bc083",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f0b9e180-98df-4659-aa0d-8b9adf6ec0d0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "034efed9-b95d-4193-b577-55e3d02c9e45",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e9e950ee-b10f-478b-9d45-d9fe8b0456c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ad421e27-82bc-4168-b752-245f778dc25b",
"db_currency_id": "1c0a7fd0-60c6-4450-b3b8-541acda90c02",
"db_language_id": "e0f38ce6-09bc-4f91-8d2d-5f9c52819cca",
"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-16T22:44:51.0085781+00:00"
},
"modified_dateutc": "2026-05-16T22:44:51.0085781+00:00"
},
"marketing_segment_id": "3b330287-742d-43fb-bc63-8a6d737ed109",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2274e009-22ce-4cbc-81c1-855819086e63",
"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": "aa78ebd4-401b-4f32-9e74-f01292f78d57",
"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": "f06c1ebd-173b-4d5a-8ce5-673ca6215a91",
"db_country_code": "sample string 28",
"feelist_id": "0b3a0571-b833-4c7b-a95a-3a855cbca06a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4b387078-5648-4d29-8264-e2d365eb9d18",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "df330d50-e9e4-4eff-a914-fb5d004af98f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-16T22:44:51.0085781+00:00",
"db_currency_id": "dbd23126-c1f7-4641-9436-ebb021428f74",
"db_currency_code": "sample string 10"
},
"company_type_id": "75913395-7c6a-4531-81c6-7b82f49fbc48",
"company_type_name": "sample string 32",
"company_type": {
"id": "9fff6968-4b8b-490d-a019-e7dbf54142fe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d494be00-4c61-4cd1-b111-f3105231398e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "74c8a954-73d2-482d-817c-5596357d5511",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "00778322-aa0b-46ac-a534-f23eaaaf6fd1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "caf9cbc5-76d7-4a55-b6c7-cce83aa7777e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "863d943d-1a90-42b0-bc88-1eff3e25db53",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-16T22:44:51.0085781+00:00"
},
"company_sector_id": "86d4df42-044e-43ce-a325-f93be87b2bbb",
"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": "dd42a2df-8442-4f88-8e32-e37ec57e9e4a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e1c925d8-35eb-4750-b66c-98ba58547931",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "886f636b-1337-4213-8645-d8183a53046f",
"account_manager_user_code": "sample string 56",
"company_status_id": "36a9b8d9-8acc-4ac1-a37f-9912426c072d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-16T22:44:51.0085781+00:00",
"id2": 60
},
"db_language_id": "e9161c44-45ad-48a9-b89f-166f8f5d79e2",
"db_language_code": "sample string 7",
"db_title_id": "2bdc865c-045e-4994-b26f-63762a72f896",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-16T22:44:51.0085781+00:00",
"create_date": "2026-05-16T22:44:51.0085781+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-16T22:44:51.0085781+00:00"
}