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": "5160d159-2fd4-4cdf-8ca4-657373141a71",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a1f64f6d-523b-4bf1-ab75-3c811dc7cf1b",
"company_code": "sample string 5",
"company": {
"id": "e0c06102-d843-4926-a54c-ba90ba48e2e8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-19T07:36:19.750288+00:00",
"sales_territory_id": "9e477a81-e2b1-4f2f-a4e5-95086bcee98b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d5b836ec-c767-4469-bb0c-8895a85c863e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90e7a098-f8da-49b5-bb2e-9d97fc21fc7f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c293fdf4-067d-4d51-afeb-8508037d85eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "911d4e8c-c294-4b9c-9e33-43c79066b595",
"db_currency_id": "89dde99d-8742-4650-818c-9960a85c16be",
"db_language_id": "d5b9889e-4ebb-4f5f-9050-09295af388a9",
"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-19T07:36:19.750288+00:00"
},
"modified_dateutc": "2026-01-19T07:36:19.750288+00:00"
},
"marketing_segment_id": "fdbfe268-3c04-42f7-bda7-3e9bebc3f476",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1cb973fb-0d4c-45d1-8695-701cf6e082f1",
"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": "448d34f8-39fe-4a36-bcb7-6ea985e2882f",
"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": "768b05b9-f3f3-456b-a5b5-d9bbeb866cb0",
"db_country_code": "sample string 28",
"feelist_id": "0c0b49f0-902c-41e0-91b5-d65e40f66400",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c88a0e8c-9a5d-49a0-a303-0e45945fcfe2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "75789d2e-ebbb-4b35-b0a3-ec03abd66e94",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-19T07:36:19.750288+00:00",
"db_currency_id": "3567aca6-e6de-4e4e-b669-8113f68fa028",
"db_currency_code": "sample string 10"
},
"company_type_id": "d07375ae-f5b1-4a98-a1a1-14946fd5f382",
"company_type_name": "sample string 32",
"company_type": {
"id": "a3295c23-f996-4802-8dba-1ec350a7a0dd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "072ccc3a-098d-4971-9294-f434506d1bc9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "945824a3-9d7e-4a58-8b86-02548028df36",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c92cac7c-d52c-417e-9f3e-974d8ecbd276",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "706201ec-a53f-4679-a24d-51d44643dcd0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "65c75095-bfbf-4b39-acbf-a850cca71915",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-19T07:36:19.7659137+00:00"
},
"company_sector_id": "5ed85c4f-4a6f-483a-9ef4-00dd5fd8e87a",
"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": "e6c284b3-faa7-4f2f-bbb5-594c68aa2081",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "422b777c-4794-4ee1-94bb-21259ccc9f62",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c6c5f692-60cd-4813-b8af-3a127cb739ef",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b84a7c2-3c1e-412f-9856-b5a81dd7cd70",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-19T07:36:19.7659137+00:00",
"id2": 60
},
"db_language_id": "fa63c274-0eaa-469f-8f5d-c2666dc81e0e",
"db_language_code": "sample string 7",
"db_title_id": "e8a3e0ba-0473-4a88-97a9-5758f7e6f75b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-19T07:36:19.7659137+00:00",
"create_date": "2026-01-19T07:36:19.7659137+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-19T07:36:19.7659137+00:00"
}