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": "b3e8eb80-296d-4158-8760-b9cd4ef86e4d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1a99b249-aa16-4e13-8e3b-60b7a0179ed5",
"company_code": "sample string 5",
"company": {
"id": "42bb04c1-0f42-420b-9812-d768d6d7f60c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T10:39:51.3517653+00:00",
"sales_territory_id": "2448b5c1-2467-42b8-b242-a67a83d60fe8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0b12ef0a-43c8-47b7-8d8d-4d07a0252478",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "311360ac-4744-4305-bc6b-b545faa68c76",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "33ba4ac9-4a84-4c01-9a0f-84f43b3f7c68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "604babcd-8c0a-4885-9085-5b4f2b0b5ae0",
"db_currency_id": "281c983b-0d1c-4ffa-b62d-fd17b465e42a",
"db_language_id": "f304ce64-eef2-4c6d-904c-d5ffd59ce194",
"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-07T10:39:51.3674138+00:00"
},
"modified_dateutc": "2026-01-07T10:39:51.3674138+00:00"
},
"marketing_segment_id": "0b8df210-dae7-491b-97d3-eebdfc6ffe1f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "96a3325c-cb8d-45bf-a923-e0e2ac8d3561",
"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": "3cb85be4-206d-494e-9828-c7ae7717f1b2",
"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": "c1f97e97-544f-4130-be4d-d29140e31dda",
"db_country_code": "sample string 28",
"feelist_id": "11fed435-4c6d-4f47-b117-481a42b82891",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "472ddef9-fbe1-4c64-bdef-5427b4f69266",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2f9f7468-e045-4b11-b296-cf0e4aa62ca3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T10:39:51.3674138+00:00",
"db_currency_id": "94eed648-bd1b-40a1-a84d-b19089efe2c6",
"db_currency_code": "sample string 10"
},
"company_type_id": "50e11a9b-1791-4433-a341-81e94886cead",
"company_type_name": "sample string 32",
"company_type": {
"id": "d3fd0e5a-d39c-44ea-abfb-4a17e000457e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21a560f0-f7b3-4cfe-a79c-fc25ce3034a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "764cd4fa-a60e-4542-bfcc-6689328bf20f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bbfb0978-2a9e-46f6-b648-3470de20de1a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9066da3f-05c6-4197-a71a-8403fff139c3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5aff2509-3ca7-4985-887b-00bbba0e82a3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T10:39:51.3674138+00:00"
},
"company_sector_id": "3e1f71cb-bcad-462e-a519-e1ea039cfd05",
"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": "114e12a6-4871-4fc8-87f4-74c9eeeb52bd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9487499a-e5ab-4f11-81bf-c794b7eb219c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fb645f4c-e74d-4de5-9fd0-ec8f35bcdb5c",
"account_manager_user_code": "sample string 56",
"company_status_id": "05622829-3aae-4090-beea-c473335b4195",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T10:39:51.3674138+00:00",
"id2": 60
},
"db_language_id": "854225bf-bbd3-46af-b271-2b59a892a347",
"db_language_code": "sample string 7",
"db_title_id": "044e7c87-40e8-4303-901e-e3424eb04ad0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T10:39:51.3674138+00:00",
"create_date": "2026-01-07T10:39:51.3674138+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-07T10:39:51.3674138+00:00"
}