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": "36536e6f-a8d6-4860-a1ed-700c7295f0d6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f1066aff-8f74-44fb-bbf6-b628d9c4c3be",
"company_code": "sample string 5",
"company": {
"id": "4ad72244-a0f1-4d61-a011-fec644101b85",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-14T02:43:39.9058033+00:00",
"sales_territory_id": "d0c274b4-18fc-4f72-a334-40ebcbb61c36",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c5f54070-52a7-48ff-89f8-7e0dba4dadfe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21a6afc7-d8c6-48c8-9288-f3c8686d968a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5c4b4b8-64b4-46e8-b863-bddee0bdc9c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9bd0f9e-a129-4d8e-84c5-f6de6732ca23",
"db_currency_id": "efa627a9-bb26-4dba-9c1f-bbda4a5776ee",
"db_language_id": "36e856bb-984e-4757-971b-81473541150d",
"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-14T02:43:39.9058033+00:00"
},
"modified_dateutc": "2026-08-14T02:43:39.9058033+00:00"
},
"marketing_segment_id": "9417c74b-9158-452f-a66a-24ee30b692ea",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5fdd432b-96ae-4816-8b78-364991adaaee",
"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": "520599a1-7254-4d21-b4c0-c80dd8f301b9",
"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": "5178fd1f-c687-4337-b7f4-7b4538e2fdb0",
"db_country_code": "sample string 28",
"feelist_id": "a0328905-5d47-453a-bc8f-8687d2177d1d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5be55079-34a0-46a1-8ec4-744bc97a0982",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "41a8b070-c2f0-4ef4-b547-3b575cff1dbe",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-14T02:43:39.9058033+00:00",
"db_currency_id": "75f69662-d3fa-472a-ab48-5600a2ad5b8a",
"db_currency_code": "sample string 10"
},
"company_type_id": "a497aefe-ad36-4fa8-9d78-53750cf74e53",
"company_type_name": "sample string 32",
"company_type": {
"id": "40a1cb64-d123-4bb0-9a7a-9f6ffbf4d28c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fa33b5b4-0311-49a3-bee1-d3f5d19309a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "352ce895-95ef-4b22-9ebc-a4b4b066e127",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6c575b7c-eca1-4766-b97d-d2f337993216",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c0b95dae-6bd7-4119-8773-8f45c4d3ed31",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7ac60dd6-e5b5-41f3-b62b-bbf4c6b59583",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-14T02:43:39.9058033+00:00"
},
"company_sector_id": "25b56295-e5da-4643-8bbc-70f4a8867713",
"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": "ae7030a3-d8b9-42aa-b3aa-f614ab3ddcc3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "537b59d1-f237-494d-ac63-0379775c39a5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c1151425-8c3e-4c12-9514-73bbd9b4058d",
"account_manager_user_code": "sample string 56",
"company_status_id": "5b16a44e-3ea2-4525-8cf8-fa6e244b3773",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-14T02:43:39.9058033+00:00",
"id2": 60
},
"db_language_id": "a14405f4-565c-474f-8b63-71818a4cfc62",
"db_language_code": "sample string 7",
"db_title_id": "1368124f-e3e3-4e5e-b672-ef780a731730",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-14T02:43:39.9058033+00:00",
"create_date": "2026-08-14T02:43:39.9058033+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-14T02:43:39.9058033+00:00"
}