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": "c64f3680-5427-45bd-a74d-f1835fac5f4f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "40289d66-055e-44e1-9cb4-0398644f2d0f",
"company_code": "sample string 5",
"company": {
"id": "8bccb51f-c090-4667-b5bf-cda0451dc386",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-16T03:53:37.7608686+00:00",
"sales_territory_id": "72102a61-a881-4aa4-9b40-2f2b0a058b93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a96daaa7-9564-4076-8a47-c1e2fa55dbed",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "62963b97-abad-49d2-ad46-399117857769",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "05e93463-700e-4d22-9076-a7df802611d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c4373f0e-806b-44b4-93ad-ecbfe9c3b9fb",
"db_currency_id": "2ca4594d-3212-41ad-9b9f-51e2cd220465",
"db_language_id": "c393dd59-499f-46bc-ad7f-881b40ac5acf",
"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-01-16T03:53:37.7608686+00:00"
},
"modified_dateutc": "2026-01-16T03:53:37.7608686+00:00"
},
"marketing_segment_id": "c603d90e-c5fe-434c-bd62-0f8fc6cfd337",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "941b0c78-c2cf-4540-8fb9-0fb9f44aec58",
"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": "75199ca0-fd39-4af4-9cd8-4da89638da76",
"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": "d9a053a7-ada5-450c-9ce5-84ea8d01e870",
"db_country_code": "sample string 28",
"feelist_id": "e5c85973-4682-45e9-afae-933f43ea9531",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f89f2bf4-03d7-4d2c-8be2-4c21994cc45b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "017fce15-df33-421e-b1e2-bd6e28d16892",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-16T03:53:37.7608686+00:00",
"db_currency_id": "a8d86999-2b75-40ea-9e0c-3bf195cfbc38",
"db_currency_code": "sample string 10"
},
"company_type_id": "ed156ad3-da08-4b36-bf90-0f19b7e55024",
"company_type_name": "sample string 32",
"company_type": {
"id": "d8112ddf-fd2f-4514-aa93-a0f8825f6165",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "043315fc-8baa-4437-a1f8-57d02bf5479a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "56ae0b3e-78bd-4171-ad3f-8fc1babee73b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "688bd35f-8eaf-4dd5-96ce-fca07330493c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a8f24d0f-dec9-4d9f-bc36-d1f78e4c8a03",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "89c9112a-4de0-48b0-a88c-4ec21c51ac3a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-16T03:53:37.7608686+00:00"
},
"company_sector_id": "e5f9a3d6-cd9a-43f5-b715-7153244ca9cd",
"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": "3d1eab46-ea8e-4100-82ae-a93ac592cfef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "902acd9b-67f4-44db-8af2-21598c10f6d2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "56c70a40-d876-4996-9bde-aef4d129bed5",
"account_manager_user_code": "sample string 56",
"company_status_id": "ee83084e-913c-464e-9ee0-42ab66f755b7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-16T03:53:37.7608686+00:00",
"id2": 60
},
"db_language_id": "8564ed2b-ee42-4d42-b8ea-46448bb7e8f1",
"db_language_code": "sample string 7",
"db_title_id": "55338a80-84a8-4091-9760-0273291f5e8d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-16T03:53:37.7608686+00:00",
"create_date": "2026-01-16T03:53:37.7608686+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-01-16T03:53:37.7608686+00:00"
}