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": "c8d30b68-2315-49f7-9ac5-c16a8461e5b9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67817350-2a18-4ee1-b5cb-45ef186c10d5",
"company_code": "sample string 5",
"company": {
"id": "703b26f6-1c8e-42a2-871e-50dbee02d953",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-31T05:30:31.0869494+00:00",
"sales_territory_id": "36a89b30-8ffb-42b0-99ca-1c9ab28863d7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8c10a79e-68c2-4cb1-8cf3-e6c3b87868cb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66fc9164-8f65-47cf-88cb-c7a01177c92c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec44eaba-f23d-4ba5-b492-88e943d7958d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "688df3d1-39d5-47f2-9960-1fd886716ed4",
"db_currency_id": "9aa33ca8-e3df-40e4-9350-32c94b0aa7ac",
"db_language_id": "474f5ede-5038-4db8-ac3d-d4603d97c434",
"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-08-31T05:30:31.0869494+00:00"
},
"modified_dateutc": "2026-08-31T05:30:31.0869494+00:00"
},
"marketing_segment_id": "4f91f787-991c-483a-924e-6991e3198f68",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a79811b4-d401-429b-81d9-ac37e2802112",
"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": "acf1f20b-4cd0-4f0b-be1a-a2a775dc370a",
"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": "dac3cfea-645e-48d4-9aea-fb4fa26110ed",
"db_country_code": "sample string 28",
"feelist_id": "8be2fac4-0831-401d-a8c9-c517c92835df",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "be948c2c-a825-4228-aec6-34da1b02a40e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "67851360-3b87-476c-ba56-fd71c8f973cb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-31T05:30:31.0869494+00:00",
"db_currency_id": "bc9e43ce-c831-4c7b-b5f8-4a039d110b04",
"db_currency_code": "sample string 10"
},
"company_type_id": "b6554b93-b986-409f-9dd9-681ddc97bd02",
"company_type_name": "sample string 32",
"company_type": {
"id": "97741ad5-96f1-4dbe-ac52-f1faf05ce2ea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cda5abb2-dc1f-4e9d-9fa6-6453dac18e43",
"sales_organization_code": "sample string 5"
},
"db_language_id": "192ee3e7-00b8-4083-93d2-d991e35d804c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4a6120fc-662b-4d7d-870d-b1dcdc2d2fa7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ce34edb8-220c-498e-9057-dbb77b16521b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "65ba678d-8f4e-44ba-b260-3841825eaeee",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-31T05:30:31.0869494+00:00"
},
"company_sector_id": "86de9979-3990-4eee-bd80-6bc4cccba0e6",
"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": "bda50023-08eb-4e7b-b333-48530f37fb8a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8df879a7-422f-4440-a869-c9c0ef31c1c1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "091dffe0-28c5-4a1b-b42a-6ef0f1886c47",
"account_manager_user_code": "sample string 56",
"company_status_id": "ed3d40a5-485a-44cb-9e5d-2c3170066d29",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-31T05:30:31.0869494+00:00",
"id2": 60
},
"db_language_id": "bbeb5118-c07a-43eb-a62f-9cef7f9490fe",
"db_language_code": "sample string 7",
"db_title_id": "235882c3-0ba3-40e5-a7d6-f564593e162c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-31T05:30:31.1025796+00:00",
"create_date": "2026-08-31T05:30:31.1025796+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-08-31T05:30:31.1025796+00:00"
}