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": "6f33379b-4074-4a0c-bac3-862c63483087",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0b218fbc-24bf-409c-91e2-c5393f852ee3",
"company_code": "sample string 5",
"company": {
"id": "28821556-ba7f-48db-a9c2-7384e64bc36c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-19T06:58:23.7977101+00:00",
"sales_territory_id": "b14c86ca-7e69-4f1f-856a-c8eadf716388",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3ef1944d-bcd9-40a6-81ac-b521e5a57cfc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf5d0f67-8a0b-41af-9458-6e86a5802d1c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f0488992-3af6-4416-9358-884892a72534",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1ddcebd-abb6-434f-9450-b5ec2e5d17ad",
"db_currency_id": "69c431bf-e1ca-4534-826f-f704110f1f9d",
"db_language_id": "6c4a5c7c-1154-42b2-8546-ae4788792731",
"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-01-19T06:58:23.7977101+00:00"
},
"modified_dateutc": "2026-01-19T06:58:23.7977101+00:00"
},
"marketing_segment_id": "7cd6ff44-6489-4181-a5cc-b2b2d14ddc06",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e9caf262-dc3f-41d2-8395-4ae4baec1ae4",
"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": "b552c0a6-763a-461b-94eb-d185a5700db3",
"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": "8d01430c-ff74-46a4-afbd-6ec85d71bbe8",
"db_country_code": "sample string 28",
"feelist_id": "b9cbf936-89ad-4d39-8a99-f8831f62c6f6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "00a84442-e0ac-4be9-b779-78c7fb9495f8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bb379d66-6b59-4809-a023-7a66e2381318",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-19T06:58:23.7977101+00:00",
"db_currency_id": "70e08141-75fc-492a-b577-e5cbff5cf1b4",
"db_currency_code": "sample string 10"
},
"company_type_id": "1eec86f7-140f-4b29-b0ab-df3ade76726a",
"company_type_name": "sample string 32",
"company_type": {
"id": "4164aecb-f3b5-47b5-9929-9b74d7601e2c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df2105f9-82bf-45a4-848e-9540451208b8",
"sales_organization_code": "sample string 5"
},
"db_language_id": "994f1489-69ae-47ed-81ad-df482410a9c1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d026695e-6d01-4d72-8749-bcbd99a4d61b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e7bb0f33-9517-4df8-8919-2b5ddeb4c009",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad4d7aeb-8edb-474f-80a2-b126d0fe3ade",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-19T06:58:23.7977101+00:00"
},
"company_sector_id": "22277961-dbf4-41ad-85d4-0c9aa02359d1",
"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": "3a42fb2f-e546-417a-87d9-a1a97ee3f98d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3fb1efe6-eb58-47c3-b066-6e88bf30c79f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a9f0693f-6571-4565-9872-c4fcb275d998",
"account_manager_user_code": "sample string 56",
"company_status_id": "ddde7e2b-1b9f-43ad-9817-d0198a175950",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-19T06:58:23.7977101+00:00",
"id2": 60
},
"db_language_id": "f36fd8ca-d8f8-4a10-b5d3-b7c6966dc284",
"db_language_code": "sample string 7",
"db_title_id": "e00c9047-7f92-4c23-967e-e3e1d1dc27cf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-19T06:58:23.7977101+00:00",
"create_date": "2026-01-19T06:58:23.7977101+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-01-19T06:58:23.7977101+00:00"
}