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": "367734d2-2850-4a2b-b4c2-0b615a62fc88",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dc6d781e-aace-4553-af88-2de572e9d488",
"company_code": "sample string 5",
"company": {
"id": "cb5d66a0-57a5-4aa9-b2c2-6555b88078df",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-22T12:22:10.2227695+00:00",
"sales_territory_id": "86c1cd39-c81a-4248-84bc-2bbd27a2be54",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6a3da23d-ec4e-4092-b475-6357756db6f0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b5fe9351-2395-4c9c-bd11-eefb5cab8129",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "479888ce-127f-40c6-b8b0-a04e29cf5b79",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09bec2e2-e103-49a7-96db-06b73d3ed482",
"db_currency_id": "6067f25f-6b1a-4772-aaf4-02ba58274bd0",
"db_language_id": "12c5f0b9-ca9a-4976-98fe-34a7f157630e",
"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-02-22T12:22:10.2227695+00:00"
},
"modified_dateutc": "2026-02-22T12:22:10.2227695+00:00"
},
"marketing_segment_id": "51acb896-cb0c-4d5d-a636-c453a59cf0a5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bbb55d2d-dc00-4ce8-a8b2-8b1c27712de0",
"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": "4a25b6de-89a3-46fd-a2e5-ceda9908d334",
"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": "a069983d-f298-4b87-9272-12463a2336f2",
"db_country_code": "sample string 28",
"feelist_id": "6a1dbd1d-a8aa-4553-84c4-9d1cc3bd0b15",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b0673456-0193-4041-acba-09575f4bb80d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1305731b-726e-437b-bf91-ffd710989662",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-22T12:22:10.2383915+00:00",
"db_currency_id": "3bc3ace7-3ce0-41a0-9344-b1c96f9b8838",
"db_currency_code": "sample string 10"
},
"company_type_id": "6ddda208-5cd2-4b6f-be49-cc9201d8bbe7",
"company_type_name": "sample string 32",
"company_type": {
"id": "4039f889-3106-4f77-abb3-e0f662d1a564",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ce18c002-80fe-49af-a592-26fa2d95d6e5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c350a5e2-9147-481c-b223-7cc60928772e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8d885c58-b4e7-4975-885f-00d3fd315af5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "73ada845-7cbc-4d4b-a742-ed51cfa70690",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4ee7e5db-b268-45c8-a474-b266e7c6b31c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-22T12:22:10.2383915+00:00"
},
"company_sector_id": "7d461961-5533-4f72-88e7-5769b908466a",
"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": "1207e5bc-c0ee-4280-afae-ca7938de2f0d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9af172c6-9537-4400-b35f-177297fdf614",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dee910fc-cd2b-431f-9b5e-10c1cebf7a04",
"account_manager_user_code": "sample string 56",
"company_status_id": "0e827533-1abd-48c0-b110-b4aab4e3906b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-22T12:22:10.2383915+00:00",
"id2": 60
},
"db_language_id": "fc25e6a6-3f8c-4829-a349-8f6674d2dffa",
"db_language_code": "sample string 7",
"db_title_id": "6ba2495e-49f9-415d-9026-8d97e005b7df",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-22T12:22:10.2383915+00:00",
"create_date": "2026-02-22T12:22:10.2383915+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-02-22T12:22:10.2383915+00:00"
}