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": "f5f9fbd4-fd5a-4a9c-878d-cab874519852",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ad26d6c6-a4e4-44b3-93d5-ee57192a604b",
"company_code": "sample string 5",
"company": {
"id": "fad504a7-bac6-499f-8754-2bff14a73c42",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-07T09:45:32.9125381+00:00",
"sales_territory_id": "e74da4b9-424b-4fab-8a9f-5be03b9d9cf7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1493eb1f-c74a-438c-acb2-0fd6a6dba209",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a572f9c2-0f93-40dc-954b-6dc30b6b1225",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0f44f703-3f08-4a29-8f5e-316b783e1734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7053fed9-1a7d-4177-8f0b-04540f9b3a9c",
"db_currency_id": "bad187a5-c710-4d6d-9a64-507572554e9f",
"db_language_id": "73fadd8f-b745-419e-ab74-3533d2d98dbf",
"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-07-07T09:45:32.9125381+00:00"
},
"modified_dateutc": "2026-07-07T09:45:32.9125381+00:00"
},
"marketing_segment_id": "2bd8c2cb-40f8-4d60-829a-4a296900e4ee",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "af4b0837-31bc-4239-afc3-2ea8328a4d3e",
"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": "7bd2e145-34da-4332-b9fe-1b218da6b001",
"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": "9a0ab7d5-04f1-453e-928e-ec3410660122",
"db_country_code": "sample string 28",
"feelist_id": "e3312374-da19-45c1-a314-c40dca4e7827",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c497fd9b-9a3e-45f0-a0a6-f340e2bbb165",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a2ce1f80-a188-4904-a0b5-2252774190ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-07T09:45:32.9125381+00:00",
"db_currency_id": "891be841-7191-4446-bcda-22878bfa9e54",
"db_currency_code": "sample string 10"
},
"company_type_id": "e1aebada-2f25-48e2-8056-a95537abad8e",
"company_type_name": "sample string 32",
"company_type": {
"id": "1fb5e057-9862-471e-aa82-f286d5116dd0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3732801b-7cb9-4027-88a8-ea6f31e6ba35",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a62cfda1-7d0a-47b7-b977-a1e37811e177",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d6f8fde6-d09f-4473-bb89-cca7c3e0b14a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8cfc9912-d92a-4b9a-b1e8-f0c66b9cf138",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4a0deabb-3402-4d1a-85b3-2b2ec9dbecdd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-07T09:45:32.9125381+00:00"
},
"company_sector_id": "b7cf7c63-71a9-4260-a3eb-2ed31738f6e9",
"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": "215b9ed1-6b08-4c69-b081-f20d6d50c8c1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7e640ced-76ef-43e5-b9e3-35318fb2de44",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4eb994e7-b808-41b2-9cb3-33f0f359a3c4",
"account_manager_user_code": "sample string 56",
"company_status_id": "0e65cd43-4564-43ae-b531-7ea7ae22928a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-07T09:45:32.9125381+00:00",
"id2": 60
},
"db_language_id": "75842eed-71a5-458f-a99f-8d3df3837971",
"db_language_code": "sample string 7",
"db_title_id": "99e0523d-c9c8-45a7-93e9-48dcd57f59bd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-07T09:45:32.9125381+00:00",
"create_date": "2026-07-07T09:45:32.9125381+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-07-07T09:45:32.9125381+00:00"
}