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": "998011ef-a7a1-400d-9be4-b956217553af",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fa42acbe-805b-41d7-96b6-d30a489b4fd1",
"company_code": "sample string 5",
"company": {
"id": "b816e522-4f1b-42e2-a024-1101db59982f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-16T07:10:48.7342802+00:00",
"sales_territory_id": "29f12729-d995-4b7c-9ba7-c0ce0465d3e1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "45bf1a74-b3ea-41f6-8221-eec5b5951ca6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a76e623-f98a-4603-a235-75e8430a7e99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d50f2c1-13cb-49c7-9e97-dbddf4d22e6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cdc86e6f-57e8-4070-801a-c8b9252e745e",
"db_currency_id": "5b7df4fb-267a-4867-a950-bf266418db7d",
"db_language_id": "911d2126-bc77-4b3c-9e21-3f27230c1bff",
"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-10-16T07:10:48.7342802+00:00"
},
"modified_dateutc": "2026-10-16T07:10:48.7342802+00:00"
},
"marketing_segment_id": "8fcb865e-c0d8-48c0-803a-45bb00267d68",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8214bb95-86c8-4ffa-be0d-6f17e4f0b0d4",
"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": "34211bf6-99aa-408a-9cfb-a33284afd3d9",
"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": "42eab894-24df-41dc-893f-9a4a1dad316c",
"db_country_code": "sample string 28",
"feelist_id": "f41bbae2-a622-462b-9adb-e99b3a84f669",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d6aa1058-b6fb-4047-8514-c6e5055b2bdf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f55a586f-5644-4d2c-bde9-e0114a3d6db2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-16T07:10:48.7342802+00:00",
"db_currency_id": "f02b3925-89e5-4277-a1ae-0212d6cc68da",
"db_currency_code": "sample string 10"
},
"company_type_id": "1df429c2-1cd2-4c6a-8f1a-81da0a41d915",
"company_type_name": "sample string 32",
"company_type": {
"id": "5e6c4e75-0c87-4748-8896-f22cce4856ff",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eccee866-55f2-498d-b58e-d2bbc5ba3468",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0d6991c5-c343-4969-8d20-2436b1598630",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6ee8bdb2-333f-445e-857f-a689c89b8df3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5522623a-ff18-4c16-b932-e2660301ec1e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "180f808a-398b-427d-95a6-76d95a57c156",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-16T07:10:48.7342802+00:00"
},
"company_sector_id": "4a22b6ab-fe3e-49e9-bd63-0b85ccc3a0fe",
"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": "5ba238c7-0668-4897-8563-5d4bdb4d76c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "93356c32-c279-4244-b124-4478f29f8cf4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "abcfaae7-6041-41a5-9ee4-b868f9b3fe8d",
"account_manager_user_code": "sample string 56",
"company_status_id": "2283e863-9eae-4af9-a0fa-8207f4432304",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-16T07:10:48.7342802+00:00",
"id2": 60
},
"db_language_id": "6b8f5b07-ae2a-4ac8-b948-947555e39acb",
"db_language_code": "sample string 7",
"db_title_id": "27567500-797b-448f-ac87-1cdc773b9203",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-16T07:10:48.7342802+00:00",
"create_date": "2026-10-16T07:10:48.7342802+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-10-16T07:10:48.7342802+00:00"
}