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": "64a08bfb-8795-40da-8d93-89ba0d1a3964",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "345a92b9-d335-4271-b0a1-9091f5dcf0f2",
"company_code": "sample string 5",
"company": {
"id": "05b36c78-bd0f-4bf5-90ba-a4b8620cf1b2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-24T11:59:53.4158887+00:00",
"sales_territory_id": "3a904d17-4028-4813-8410-8cf0c79df06c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "226d91de-2677-43fd-8008-b1ab31d8fee0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6132701e-7fdd-4896-8307-5e41930b090c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "067fa8c0-39ac-45ff-8af7-3cefdce94315",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "122322fe-c485-4795-937c-498efc0ec32f",
"db_currency_id": "7c698321-d6df-41fc-a633-b47adca5619b",
"db_language_id": "d93f2618-9b38-4731-a0e4-cce7f647b05c",
"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-07-24T11:59:53.4158887+00:00"
},
"modified_dateutc": "2026-07-24T11:59:53.4158887+00:00"
},
"marketing_segment_id": "4bfdea9b-b8fa-484e-b944-0721032334c8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4f945c8e-5b14-4e88-86c8-a4e235b981c9",
"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": "3d7ec875-8504-4b3d-95db-1a37b22505b1",
"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": "4510db4c-173d-434a-89e8-adb57ff0c6d8",
"db_country_code": "sample string 28",
"feelist_id": "07e5ff69-94fe-4028-a92c-50189659c73f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "46563c58-770e-4b0b-9553-108c6f3f52ee",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1556d0d9-9834-4d99-a576-59e132e181ed",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-24T11:59:53.4158887+00:00",
"db_currency_id": "43857615-65c3-4fcc-a336-e2c2ab564c05",
"db_currency_code": "sample string 10"
},
"company_type_id": "d5d6ce89-1c80-40c4-b088-83ef18b5749d",
"company_type_name": "sample string 32",
"company_type": {
"id": "ca234eb4-ad54-44ca-814f-004b9bd2330e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "664bc690-6f06-4789-969e-de44ef90e06b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "976852e4-e396-48ba-bc61-0e922e7a8d0a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fcae7278-23d3-4ae1-bb29-da58fbf53330",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9ce53e64-d6de-4878-ae0a-d334de341712",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "02ed554c-861d-4ce6-a9d1-6c242b1a8f46",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-24T11:59:53.4158887+00:00"
},
"company_sector_id": "f3d1cae8-e4c9-4eaf-b129-3941a886ef90",
"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": "cd340eec-5e66-4aaf-beb5-d3d362daa303",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a8477c25-8652-4c4e-8eff-ab426255c2fd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "27b4d036-50b3-4233-b8b3-78bf47ea43e4",
"account_manager_user_code": "sample string 56",
"company_status_id": "f33916b7-218b-4cac-bf06-6d2d084f6369",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-24T11:59:53.4158887+00:00",
"id2": 60
},
"db_language_id": "3e56547a-eccb-4992-9474-894197d044fa",
"db_language_code": "sample string 7",
"db_title_id": "cbc90b71-95bd-407c-82af-911ac5e6d54a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-24T11:59:53.4158887+00:00",
"create_date": "2026-07-24T11:59:53.4158887+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-07-24T11:59:53.4158887+00:00"
}