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
{
"id": "5459685c-2aec-4162-8b5f-3c24f5e9e7ef",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "917f2f55-a2fd-4fa6-bcf1-94c37bd92b2a",
"company_code": "sample string 5",
"company": {
"id": "3983bbd0-221a-4a2f-aef7-cf958ded4ab4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-17T09:41:17.7147692+00:00",
"sales_territory_id": "3b1e4a2b-e8bb-41fa-9745-908dbff648fd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ee4bd959-9768-41a5-85e8-396f6b64789e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3a331be4-049e-4441-8b08-37409ff75e99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4bf2a0cc-e3ca-4db8-b7cb-34337fddeed9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bb62bc2-4fbb-4792-b8e7-498e32d49a82",
"db_currency_id": "f74450d7-cd5c-4d5a-a1f1-dcf154b0ce24",
"db_language_id": "a4fdc3ea-ac6d-49d3-bb00-3420d9e09799",
"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-11-17T09:41:17.7147692+00:00"
},
"modified_dateutc": "2026-11-17T09:41:17.7147692+00:00"
},
"marketing_segment_id": "3dbe4a47-2648-449d-b3d7-84d841935f33",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "29816210-eddc-48be-b8e7-91f59e5c1857",
"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": "b448cd4b-cbd2-4f6a-a2aa-ecb1aa3da4d3",
"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": "76896cdb-c5c0-4c04-afae-ee0fce4d0427",
"db_country_code": "sample string 28",
"feelist_id": "ef9b597d-cc17-4f84-a627-a7e57c9b859e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cebd1360-74cf-4007-9dca-8fcaaf37775b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b9362468-4daf-402a-ad52-13762f0b9432",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-17T09:41:17.7147692+00:00",
"db_currency_id": "c3fdf4de-22c0-43aa-9e01-a5b0e9198bb8",
"db_currency_code": "sample string 10"
},
"company_type_id": "a57ff6f9-0acb-46c4-8c9d-5ca90e386217",
"company_type_name": "sample string 32",
"company_type": {
"id": "9acf7430-ba54-49f3-a313-980afe31fedd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "916ede87-9a48-42fa-afd7-bfbf0e24a6f6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "39825e69-3e6d-45df-a100-4724e702b865",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "623f6522-7f1f-4ba9-8acf-2c60ac9e3a14",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c0fc53ef-bd71-441d-8e60-3d3b4a45fcb4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9731fb30-c069-49c0-b35e-29355d387755",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-17T09:41:17.7147692+00:00"
},
"company_sector_id": "2a83bbaa-0355-460d-a826-ca8e7444ff04",
"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": "e4d13c25-03dc-4f1c-a296-1e7e3bd9f2e7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "83a76efd-d205-4e6e-86dd-8b18bff0e9c0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7825346d-ea18-4f22-806d-596a769355a9",
"account_manager_user_code": "sample string 56",
"company_status_id": "0bba3449-ff46-4233-848e-bd95ff32f28d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-17T09:41:17.7147692+00:00",
"id2": 60
},
"db_language_id": "0c4852c1-8df6-4fc5-9ca7-43a90d1cf525",
"db_language_code": "sample string 7",
"db_title_id": "c9bdc9e5-2167-456e-8790-7616d7dbf458",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-17T09:41:17.7147692+00:00",
"create_date": "2026-11-17T09:41:17.7147692+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-11-17T09:41:17.7147692+00:00"
}