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": "e2669fc9-62d0-4f5f-a633-4299c7cbb24a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8ef5dcbf-4e47-4698-bd9d-50831d250f3a",
"company_code": "sample string 5",
"company": {
"id": "b4d641bb-dc98-4934-b0f7-c7a65f65e147",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-02T10:10:16.5474309+00:00",
"sales_territory_id": "df87c4b9-1e72-4165-94e5-c5402fb53fff",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4edabdac-d767-4bdf-adbb-e9d309dc8f69",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "171961e4-ef22-435c-84d2-668a9f96efd4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1399479b-421e-42f7-959a-27d3128d5f53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "111377ee-3c1b-45bb-bb41-04068cdf9906",
"db_currency_id": "66557313-e48b-4725-b8c5-efe7e1c5f3d0",
"db_language_id": "95c90775-421f-424c-8a4a-587299e5038c",
"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-02T10:10:16.5617773+00:00"
},
"modified_dateutc": "2026-10-02T10:10:16.5617773+00:00"
},
"marketing_segment_id": "ebc2cf47-bf03-4df4-9105-e46ceb2c4bd3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3e72cc8b-6e11-459f-9a3f-17b8340cd3e9",
"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": "e69825d9-abf4-447e-b6a3-45a14cb29363",
"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": "538f7b51-6819-46b2-92a9-5b4d9d415fd8",
"db_country_code": "sample string 28",
"feelist_id": "72fa6e2f-797d-4cdf-aa34-baf89d918e90",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "39393e4e-9e91-405b-9219-c53e038cdc63",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8dd2c6d2-a4ad-42cd-beb9-d3446c8270b1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-02T10:10:16.5617773+00:00",
"db_currency_id": "641af52e-3586-4c0c-a870-ddbcf2704068",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf8d35e2-5848-4766-bf32-cf7b508a9763",
"company_type_name": "sample string 32",
"company_type": {
"id": "9974302d-d482-4b1b-8cbd-73888b1989ad",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "17c10e4b-1835-4bf8-b640-cdf590a557dc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0c98dfbf-fc0b-4519-8b25-86657eda40e6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bf14c757-5fe6-433e-9376-953f7d665b5e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c2a34c4e-31ce-4356-986c-b6769ee2e9cb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7bb7f7cf-67ab-471e-b39a-4b807713043e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-02T10:10:16.5617773+00:00"
},
"company_sector_id": "1a4cb52b-02e8-4d6d-b921-70411efd5eac",
"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": "6aa094ce-38bb-45fc-9a6b-5bf365b2284f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ccb761f0-f63d-4dce-aa01-7a2314c2f586",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ecb66d0e-c871-409d-89a5-00691b5497b3",
"account_manager_user_code": "sample string 56",
"company_status_id": "3a56fc5e-458e-4e78-b587-f7411ead645e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-02T10:10:16.5617773+00:00",
"id2": 60
},
"db_language_id": "c5858b37-28ed-4033-a580-74af50ff659b",
"db_language_code": "sample string 7",
"db_title_id": "2f932ea7-6769-4d3b-87f0-2b09623f2afd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-02T10:10:16.5617773+00:00",
"create_date": "2026-10-02T10:10:16.5617773+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-02T10:10:16.5617773+00:00"
}