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": "952a08a7-de33-4a49-b8dc-66d8055dcf0c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3fe82406-4a20-4136-9b89-f08d88384e3d",
"company_code": "sample string 5",
"company": {
"id": "022cc340-09cd-47f7-a10b-d590754e1938",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-26T11:53:08.7418287+00:00",
"sales_territory_id": "1a7c5a50-f26f-4312-aa22-9f587e63059b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7be73f0a-b090-4178-9582-b3ce9392e4d5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "577e6921-4857-4b8c-ae59-55f9999c0a6c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cdc0dba0-71ae-47f5-893f-0ed3384a1ef0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24b5c96c-1aa9-467c-bdcd-99f76a1b846e",
"db_currency_id": "f946a7cf-c9f3-4e24-a8cf-f130a94bde0f",
"db_language_id": "541d3607-b85b-4915-8162-a58788c91e2f",
"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": "2025-10-26T11:53:08.7418287+00:00"
},
"modified_dateutc": "2025-10-26T11:53:08.7418287+00:00"
},
"marketing_segment_id": "46b7f2ef-2f31-42b8-8df7-046115e23cb9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ad40e31e-6293-4c20-98bd-54498989bed7",
"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": "b46ea087-ca1c-498d-968b-9efd8645c597",
"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": "77aff8e1-cb31-46d9-84b1-b20e55e397d1",
"db_country_code": "sample string 28",
"feelist_id": "c69207fe-6da3-46bf-ab52-4eb245dd572d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "60b05584-15f5-407b-b7c1-a8b37f826c8f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5b9622fb-0f3d-458c-87f4-ee550708d4b3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-26T11:53:08.7418287+00:00",
"db_currency_id": "14ec0b18-48b7-4aba-aa48-b9b0846387e6",
"db_currency_code": "sample string 10"
},
"company_type_id": "a6e0c374-b655-4fb8-8ae1-6f01bbd6defc",
"company_type_name": "sample string 32",
"company_type": {
"id": "67ce7382-be1b-4d9b-a142-79fc6ffaf3a4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fb8bb6c7-e47e-44d6-8d94-0224b2faa623",
"sales_organization_code": "sample string 5"
},
"db_language_id": "80642536-f5c7-4b31-911c-4fda7f3a3e46",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f13fcf3a-dfda-47b1-ba23-3177ba7de5f9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "90ab316c-902a-4ccd-bd66-cfbf2c868b2b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5a7a91df-8fea-48d0-9ccd-828e96e717ee",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-26T11:53:08.7418287+00:00"
},
"company_sector_id": "8de2ea62-62d7-4f43-9d51-558e61d66204",
"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": "dee89b23-8c1d-4827-bb20-6445727dd39a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dce7a660-f760-4d0c-bfbd-c86f32c02a82",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "81bbf3f5-e324-4e82-a6e8-d8241a084e49",
"account_manager_user_code": "sample string 56",
"company_status_id": "bd64887e-9638-4362-b8b2-113d7e2f0951",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-26T11:53:08.7418287+00:00",
"id2": 60
},
"db_language_id": "4fa4af55-92ac-44d1-bda6-603f527a9606",
"db_language_code": "sample string 7",
"db_title_id": "0a50ee0f-1926-4059-bb10-bacf044ec535",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-26T11:53:08.7418287+00:00",
"create_date": "2025-10-26T11:53:08.7418287+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": "2025-10-26T11:53:08.7418287+00:00"
}