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": "673156b4-9205-4656-ad10-cd0401718a81",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a249460b-16e1-4ec2-b55b-cb6b0cf34a8e",
"company_code": "sample string 5",
"company": {
"id": "28e89cca-d761-4fbf-b25e-1eb37ff2c550",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T04:24:34.0292437+00:00",
"sales_territory_id": "f90d2684-e8ef-4035-bbd0-306739365de0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10dede5b-62c1-459e-b26e-b9d9d7fef89c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a05b795d-63ec-4e49-9a34-b1e050a5496a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b4bbeae-939f-4c96-ae2e-9dab69bc0a3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d4519f0-9356-49cd-ab85-b513a741589e",
"db_currency_id": "df105f3f-ca9f-4ec2-a58a-16436ceff72d",
"db_language_id": "6a535212-df89-4cc1-b75d-de97e5a1d26e",
"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": "2025-09-18T04:24:34.0292437+00:00"
},
"modified_dateutc": "2025-09-18T04:24:34.0292437+00:00"
},
"marketing_segment_id": "44336960-36a4-48cf-8ced-ee17da8d623c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c792fd6f-cab4-4c14-be92-c3a22f3c133c",
"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": "e9038a91-1828-4800-976a-7b772f9f7418",
"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": "9fd6946b-bc19-47ba-a66e-a9d2445a6c33",
"db_country_code": "sample string 28",
"feelist_id": "807b9424-1eb7-47bd-9b42-8ff95828b0c1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "259f2078-6494-443f-82fb-7700a94776c2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "78f0fa1a-9d76-4b9e-9b95-dc0cf6f19592",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T04:24:34.0292437+00:00",
"db_currency_id": "65147a6a-757f-4f18-b2c3-7ef82915b21e",
"db_currency_code": "sample string 10"
},
"company_type_id": "6f34604e-fe3f-4d44-9e50-c7318d080a32",
"company_type_name": "sample string 32",
"company_type": {
"id": "32d02d40-1443-4a90-9115-9481d1838a83",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e97311cc-1d5b-408e-a673-690e303880c4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5aec2556-1e8a-47a7-a771-b9eb8b963b39",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "601cfe09-8b33-4eed-958a-2ea5a78d6eee",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "07616cf7-4e5b-44ad-944a-1f023e6aa302",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8629a5ab-3fa5-43ab-845b-f9ab14c63778",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T04:24:34.0292437+00:00"
},
"company_sector_id": "e6581ec3-5f1d-41bf-86c9-eff87dd6d13b",
"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": "a80a5bfb-5c54-41fe-a56d-b5d691dde2a9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89b98efb-87c2-4153-be44-50f1c0f5c331",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "77a927e1-5ddf-4286-bc0f-0fabcc8dd173",
"account_manager_user_code": "sample string 56",
"company_status_id": "bb175a6d-159c-48f9-b5ba-7d7a04139234",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T04:24:34.0292437+00:00",
"id2": 60
},
"db_language_id": "5fdad424-384f-4f02-a992-c3a139aa93c6",
"db_language_code": "sample string 7",
"db_title_id": "bf3e23c9-bd5f-4ae6-ab21-ec71df1e0697",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T04:24:34.0292437+00:00",
"create_date": "2025-09-18T04:24:34.0292437+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": "2025-09-18T04:24:34.0292437+00:00"
}