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": "0186ae48-395b-49fd-beb1-f71c561a82bd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc373eb2-3c64-4260-bbe6-2fd809b03bc1",
"company_code": "sample string 5",
"company": {
"id": "876db3dd-c76d-4ee9-8b3d-aff1f61c0389",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-15T17:13:53.0562755+00:00",
"sales_territory_id": "234c5f39-0d9b-4bc3-a453-cf5582380e68",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "15de54f9-5d2b-4b50-ab2b-a88e50f3d100",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0fb6ca06-03f8-4359-b03b-4e7420ad5369",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fab639c4-04f8-4619-8153-5342fac9ad15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a7ec330-250f-44be-8dd8-2af20a2a8caa",
"db_currency_id": "28c3cdae-b1f4-414b-84d7-2cac529a4066",
"db_language_id": "db73fc78-0452-4d29-829a-f52549955b3d",
"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-15T17:13:53.0562755+00:00"
},
"modified_dateutc": "2026-10-15T17:13:53.0562755+00:00"
},
"marketing_segment_id": "4b2f034d-2ff2-4a1f-9dcd-d8dca985f898",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4136c2bb-5590-4813-a0e7-afd06e88ea93",
"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": "bee625c3-fbbd-4bcf-8a96-3c2190568f30",
"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": "4bead1b7-9ce0-4c27-9281-c1e4c157de9a",
"db_country_code": "sample string 28",
"feelist_id": "c9a1d760-9a7e-4f92-a502-f06176213732",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "263243a7-2fc2-4ceb-919b-0a605c605ab8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "18d0b2ee-1c05-4993-b11c-17336d57e914",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-15T17:13:53.0562755+00:00",
"db_currency_id": "bb51f6dd-928e-4e05-a03f-7b93f6e5f9b1",
"db_currency_code": "sample string 10"
},
"company_type_id": "fc3d7210-b2e3-48c9-93b1-b2e89a018a65",
"company_type_name": "sample string 32",
"company_type": {
"id": "17814295-32c9-4f9f-9e36-744ba91536fe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d9fa6c86-e1a7-4d1e-b9e0-1c03673e175f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0a8c2049-f9a5-45ec-9ebf-d6aa076fc3b3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "819f6ec0-18a6-41a5-9b5a-0c6e3e4f0bc3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "58d5bed9-e6ef-4c27-8aba-5126b1e478e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e915fc03-f37d-4d41-b493-698668160a51",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-15T17:13:53.0562755+00:00"
},
"company_sector_id": "28be3772-f2e7-438b-bf6e-ee433bc05e0a",
"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": "af305d44-62bd-4192-a293-b5924235d6b2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "23386d63-fffe-483b-ade5-5ee8c0cb55a7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "807c0c48-c894-4bfa-a9f1-793bcf33a749",
"account_manager_user_code": "sample string 56",
"company_status_id": "30d76f63-fce8-4b0e-b0d9-4b371f00b578",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-15T17:13:53.0562755+00:00",
"id2": 60
},
"db_language_id": "418fbbe7-d378-4cd3-aeaf-fcd716d6f646",
"db_language_code": "sample string 7",
"db_title_id": "5da0d8c5-b0fc-46bf-af5b-d5750f413e77",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-15T17:13:53.0562755+00:00",
"create_date": "2026-10-15T17:13:53.0562755+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-15T17:13:53.0562755+00:00"
}