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": "231ea296-3266-4dc7-b88e-6a31c4cda82d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1aa80ea8-4dee-4311-b19e-5fdbf1fa3091",
"company_code": "sample string 5",
"company": {
"id": "17335ea5-9f57-4931-945d-5053f8a2d0af",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-05T21:23:57.0295214+00:00",
"sales_territory_id": "4bb85a23-4714-46ff-8354-29760ec25d84",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7be1411d-6fc3-45e4-8964-5ac389f72357",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5ac7ec16-c502-4b78-8640-a1f28755bfdb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d3bae838-aa95-4caf-a8ec-63b4e1a8ef05",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f1af294-d9cb-4c68-abc5-d775c61bc2d3",
"db_currency_id": "953732e0-95ce-463f-b875-728c19e90ad0",
"db_language_id": "6f267abc-ff5d-4c73-a890-ecda4b8ede37",
"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-06-05T21:23:57.0295214+00:00"
},
"modified_dateutc": "2026-06-05T21:23:57.0295214+00:00"
},
"marketing_segment_id": "8dc631d4-81a3-4e21-9048-12e54f77fe8a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7e9abc83-523d-4ae0-ae0e-24f639765ffb",
"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": "7e1b46a7-caca-411f-90dd-6fa540b15f9a",
"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": "76001da2-ccbb-4d4b-b8a8-4df0e814ef86",
"db_country_code": "sample string 28",
"feelist_id": "c57c4cfa-d667-46df-b2b5-3b5cc90271d0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "729b1d28-8503-4cb8-b0da-6da4da333446",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7bfacb52-0eb7-4580-bdd0-a576510868ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-05T21:23:57.0295214+00:00",
"db_currency_id": "73dc3d80-5f86-4294-aae3-51d91d1888a7",
"db_currency_code": "sample string 10"
},
"company_type_id": "dc182a67-c58a-4eff-a234-86990a93f2b3",
"company_type_name": "sample string 32",
"company_type": {
"id": "f403791b-58a7-4c5c-8aeb-641d231de33a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "775d1cfa-2e3c-4ca2-b404-ae057bd9e6a6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6d1990cb-f552-45be-ac57-7d04d8339a31",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f597c0ed-584d-482f-a190-e5f0c9bd4ea4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c0d51abc-8ba5-4ba2-835c-919a9c4da9e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e5de3fee-65aa-4ee5-b58e-1a7c7d43fc63",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-05T21:23:57.0295214+00:00"
},
"company_sector_id": "04f535c8-d592-44d6-8d71-b500ef2dd684",
"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": "11b2ff26-9633-4501-a69f-0cd989a933d4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e19f00c5-129a-4f13-a200-245d9269891f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "720bc670-c80e-4e47-a1c7-f4985724371f",
"account_manager_user_code": "sample string 56",
"company_status_id": "4d0d057a-35ec-4a32-9a41-60987abd560b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-05T21:23:57.0295214+00:00",
"id2": 60
},
"db_language_id": "35e96cc0-b9e9-41a4-a802-da941688e182",
"db_language_code": "sample string 7",
"db_title_id": "7cf0b851-737e-4884-b0c7-08e6ad4606d1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-05T21:23:57.0295214+00:00",
"create_date": "2026-06-05T21:23:57.0295214+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-06-05T21:23:57.0295214+00:00"
}