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": "1d57ee00-24dc-4611-8723-705d894a3c11",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "72be4eb9-2bc9-4835-a860-88a01e8119ec",
"company_code": "sample string 5",
"company": {
"id": "44435843-359d-4a1d-ad88-a61e87046ccb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-07T04:08:52.0871396+00:00",
"sales_territory_id": "4c72fee6-45b3-48c6-8939-fa42e20d6eb5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10eed218-ccef-47c2-bcd9-c94173ce9653",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "67baa002-c9fe-4090-a852-d298e0a21021",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de7b3082-9646-43b7-bf4f-72c97559368b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9086746f-c16c-4d59-9452-408b28bc8c51",
"db_currency_id": "4c9e126f-7427-48ef-87c6-cb4092b5d5a6",
"db_language_id": "0fee419b-04f3-4712-8d6c-aecc41eadd5d",
"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-07T04:08:52.0871396+00:00"
},
"modified_dateutc": "2026-10-07T04:08:52.0871396+00:00"
},
"marketing_segment_id": "d1ef6180-70ba-4efe-afe3-46dad57466a4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "83d7430d-a3bd-4f1b-b00b-82b3137f615a",
"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": "321be598-c2b7-4ac6-a91f-c54df9f3d203",
"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": "bdea82fd-ae59-4065-982b-ece1c683a9e4",
"db_country_code": "sample string 28",
"feelist_id": "01868dbb-d248-4217-a43d-7c66411113a0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "00a70ef7-1be7-4707-b97f-19124798f2b3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a5f97d09-54b1-44b7-b7d0-5193cfb3b80e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-07T04:08:52.1054736+00:00",
"db_currency_id": "8c00ce99-a87d-4f71-9691-fabb19415684",
"db_currency_code": "sample string 10"
},
"company_type_id": "8c3614bb-ae46-41ae-87e7-cd30e7707779",
"company_type_name": "sample string 32",
"company_type": {
"id": "a8d60c90-53ab-4647-b471-cacd69d41da2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66be59ad-460c-45b0-8b22-9c84c20b26d1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "18daa150-c857-495f-adc5-98badd6c715a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1c90646a-4d0a-48d6-8cc3-f3712539af1c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "841416a3-ab20-4a0e-8173-66d0d0704306",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d2c1a7bc-0c05-4edd-9a4f-e2be9ff4f6a8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-07T04:08:52.1054736+00:00"
},
"company_sector_id": "9d7eb4cc-45ed-44cf-a68a-3e39a8b5cfe5",
"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": "013a365a-6aee-44c9-99fa-94dec35d0827",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c6e1e361-61da-4020-8b8b-6f9be0b7787e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0a9d61a9-a091-4202-a679-c93648caf1c4",
"account_manager_user_code": "sample string 56",
"company_status_id": "920f7db1-5de9-4d5e-b60b-232e60947255",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-07T04:08:52.1054736+00:00",
"id2": 60
},
"db_language_id": "850c0be4-ed6a-456b-9431-98629597e9f8",
"db_language_code": "sample string 7",
"db_title_id": "96e5d362-edfd-4060-83fa-44a38ea4361a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-07T04:08:52.1054736+00:00",
"create_date": "2026-10-07T04:08:52.1054736+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-07T04:08:52.1054736+00:00"
}