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": "73fbf42f-5a3c-440b-adb5-cf60e6182856",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b8dda9c5-c9a7-4338-b33b-7fd1b0ce51e7",
"company_code": "sample string 5",
"company": {
"id": "65800118-d20c-4728-80f2-6a8faed79246",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-06T22:48:04.6074583+00:00",
"sales_territory_id": "7e7b2ce5-10d9-47fb-b960-ec4c9a64d352",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "83d97220-5036-4ef7-af7c-ec57d50a8eed",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "418ef1bd-eaed-4760-9551-fd10700a32ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6347b3b1-20b7-460a-84f6-feecf095be5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a032cc14-122e-40b1-94a1-cd9b6352fbfc",
"db_currency_id": "b041cb7b-4f9f-4bc1-be60-a68d9fdae52e",
"db_language_id": "00dcce4d-0d39-4835-a9f6-763f86885c03",
"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-08-06T22:48:04.6074583+00:00"
},
"modified_dateutc": "2026-08-06T22:48:04.6074583+00:00"
},
"marketing_segment_id": "4a7080dc-cb1d-40c4-88c6-6c5a015ad716",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ba57b9c6-b5df-4f1e-9b1e-0a1073159a02",
"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": "e3880f56-16a4-4a58-a723-daa887e1e444",
"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": "4681b60a-83fe-4e3f-b4c0-7feab8a7a307",
"db_country_code": "sample string 28",
"feelist_id": "d65794db-37f7-4e5c-a397-1c70a5150cb3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "86618c6b-8f31-44b1-a31b-ef6b5661b0a2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d7191dd4-3d16-47f5-9c52-fdb4179646c7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-06T22:48:04.6074583+00:00",
"db_currency_id": "1d6f71cc-6721-4d79-8a16-97b4c1a55d89",
"db_currency_code": "sample string 10"
},
"company_type_id": "03873e5b-80d9-41c6-88ab-d4a5421a9b49",
"company_type_name": "sample string 32",
"company_type": {
"id": "61f7598e-9f2d-4445-921e-e25f09a41f0f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81542185-05f1-4182-a20e-37a054cde07f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3ffa67f0-0c3d-4727-927b-fbf9446e3104",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d9fa79ed-b62c-4a19-9356-0c95eaef7a4a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "700e97bf-ba6c-490a-a0f5-7aad75dbd00c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a327cd8b-1ab1-41de-9832-68428f6d47f2",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-06T22:48:04.6074583+00:00"
},
"company_sector_id": "7d0b2c00-1dc4-40cf-83a8-2e89722665b7",
"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": "0100f80a-35a6-4214-8116-db8825e293c1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a518814-fc3d-42df-96ef-0309e5423a3c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e5187366-70a6-4586-b115-88fdf59e1269",
"account_manager_user_code": "sample string 56",
"company_status_id": "ce3c3d98-4be3-45be-bfcf-5867eafd0b95",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-06T22:48:04.6074583+00:00",
"id2": 60
},
"db_language_id": "58fd2bfe-c849-4f8f-bd95-bcf11c3b9649",
"db_language_code": "sample string 7",
"db_title_id": "8d0cd6b4-c626-472d-b0e9-33fa39663aae",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-06T22:48:04.6074583+00:00",
"create_date": "2026-08-06T22:48:04.6074583+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-08-06T22:48:04.6074583+00:00"
}