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": "4584dc06-6db5-49a2-a5e0-fbf26ac00eda",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "149febd5-0565-492a-bcd8-96e0a4b6f4f6",
"company_code": "sample string 5",
"company": {
"id": "f34111f4-c9d7-4d9e-a587-d5892ef06593",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-30T09:56:47.1244043+00:00",
"sales_territory_id": "7c7fb651-5a6c-4e21-9ee2-8b6106aac470",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "77fea399-bf83-4d83-b9e1-1ce7058c04a4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fbe59d4c-5ca6-4451-a40c-f3ef2791d82a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "30ed282e-af28-44a0-b43a-77a063b5f7c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a4804c4-dbb4-48d7-939c-326056e1cb76",
"db_currency_id": "e2b859ca-a4a8-4ab3-ac8b-28a823359ead",
"db_language_id": "78aaa54a-9d1a-406e-a3a3-9fac9d2ebed4",
"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-06-30T09:56:47.1244043+00:00"
},
"modified_dateutc": "2026-06-30T09:56:47.1244043+00:00"
},
"marketing_segment_id": "341f839b-74fc-42e8-bec5-5af22f53d2c5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3e43e478-94af-4589-b372-a62b91cdc9fd",
"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": "dabb80f4-8877-437f-8faa-c81d6e086eb5",
"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": "9bba0572-603f-448b-b3b1-22b514565add",
"db_country_code": "sample string 28",
"feelist_id": "c5359b61-0607-4cc9-b151-67e44f949385",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3dcbb53f-7f16-467c-89cc-d1bd1f0bad92",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "60881e5b-cd3e-49d3-9d8f-aa7928f88292",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-30T09:56:47.1244043+00:00",
"db_currency_id": "6c69f37f-1f4a-49eb-9f25-230f0b1c5772",
"db_currency_code": "sample string 10"
},
"company_type_id": "cf52727d-5ed3-411e-941b-b52d2f353581",
"company_type_name": "sample string 32",
"company_type": {
"id": "bf670b46-f3a5-4e02-92f3-e9a4e1d189a3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df2f8706-7449-4f5c-b0e9-491fc42aab79",
"sales_organization_code": "sample string 5"
},
"db_language_id": "325ea4e3-f773-425b-8b1e-59f8176e0807",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5b6e21c6-635c-49c3-95c6-38ff3de3e61f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a5f6b32b-1f4f-426f-9866-c0bb793d7c64",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7a650775-36e8-42c4-9827-124c1b1a67ba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-30T09:56:47.1244043+00:00"
},
"company_sector_id": "130f8f0a-ae07-40a7-bb0f-326580a1924c",
"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": "b01b9ac8-39d1-4537-b6ab-26e59b0f52a6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f65394a5-e4f6-4876-9abf-424aa52d4ecf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4805a3e8-b6b0-40b4-af3a-31d6efc9c434",
"account_manager_user_code": "sample string 56",
"company_status_id": "df0f73db-28b6-42d7-bc63-1bc869eaa74a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-30T09:56:47.1244043+00:00",
"id2": 60
},
"db_language_id": "409b5520-5e79-4970-b255-29fe8af0946c",
"db_language_code": "sample string 7",
"db_title_id": "15c52fd0-87c7-4ebc-b15a-8fd0f5df2d6c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-30T09:56:47.1244043+00:00",
"create_date": "2026-06-30T09:56:47.1244043+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-06-30T09:56:47.1244043+00:00"
}