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": "c028abfd-7fbc-4979-9ffb-124ec6deed01",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4ab3496a-56da-44c0-9765-9cf6c08581a3",
"company_code": "sample string 5",
"company": {
"id": "9a0f822f-d2c1-434d-bd00-8a9021ceaddc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-05T14:06:52.7740222+00:00",
"sales_territory_id": "7b2233c2-b698-4299-a645-92012a56ee01",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d5771f03-e3dc-4f12-9bb2-098e7caf28ec",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90bb3a7d-bb65-4bc2-aeae-247dce273fbf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7d277f3d-04d8-4d39-a3ef-d86838930a17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9e61218d-e27d-4477-8392-47b06e137929",
"db_currency_id": "22ae5aa9-44e5-4640-8093-8b75a8ff2020",
"db_language_id": "05ba73e7-fd2d-4e95-9cee-f02819b423bd",
"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-11-05T14:06:52.7740222+00:00"
},
"modified_dateutc": "2026-11-05T14:06:52.7740222+00:00"
},
"marketing_segment_id": "e80accde-b02d-4c1e-94f2-1d74a7203400",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9b59a78f-9ef0-4076-b0be-a5ba703f6694",
"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": "4529abd4-0e13-49f2-85c7-9eadaec02ade",
"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": "f46c8ff8-307d-43a0-b358-7f31bf029264",
"db_country_code": "sample string 28",
"feelist_id": "b66e3ecc-8e2d-4e1e-82f7-f7439c550c3f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2894dc31-ed54-4ae4-b442-066630950ffb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b3b156de-1f56-4649-ae1b-31dadfa1b08b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-05T14:06:52.7740222+00:00",
"db_currency_id": "057c312b-4cff-4342-bb23-e84b5ce43168",
"db_currency_code": "sample string 10"
},
"company_type_id": "1f85e99a-fa1d-46d1-8382-367574e2df9e",
"company_type_name": "sample string 32",
"company_type": {
"id": "fa9f2d51-0265-4ecc-b4a1-b4ae36396dbf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3d5af7a0-fa73-4552-8728-90af7c48c557",
"sales_organization_code": "sample string 5"
},
"db_language_id": "19a9f6da-0a24-448f-8c09-63bc48b8602c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60f86792-fb9b-4e82-8a4e-790811c45141",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "796fd70e-9dc1-4834-965d-8731b3cbf06b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d13141bb-1787-471a-8531-06e86917b011",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-05T14:06:52.7740222+00:00"
},
"company_sector_id": "bb03c8d9-b6bd-47a3-b9f7-1f6ed173e335",
"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": "70299d2a-b06c-48a6-b4e3-bdb144c6edbb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "62908c6a-c443-4d2d-b3ee-49e71f01a196",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "61e643c5-010c-4f93-9cd8-bcb8bb349e55",
"account_manager_user_code": "sample string 56",
"company_status_id": "074788c4-ac7e-4736-8d14-40f617fc5aa3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-05T14:06:52.7740222+00:00",
"id2": 60
},
"db_language_id": "668d58ae-f3fc-4a27-8467-7ccd0f47931b",
"db_language_code": "sample string 7",
"db_title_id": "55c375d5-d9c8-49ad-abc1-ff9a87cfb7a8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-05T14:06:52.7740222+00:00",
"create_date": "2026-11-05T14:06:52.7740222+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-11-05T14:06:52.7740222+00:00"
}